Cisco-IOS-XR-mpls-ldp-cfg API API Reference

API generated from Cisco-IOS-XR-mpls-ldp-cfg@2017-09-30.yang

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

MPLS-LDP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/

Update operation of resource: mpls-ldp

mpls-ldp_schema

mpls-ldpbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "enable": [ null ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "on-proc-restart": "integer",
          "on-session-up": "integer"
        }
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "vrf-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "mldp-rib-unicast-always": [ null ],
                  "enable": [ null ],
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "route-policy": "string",
                        "root-address": "string",
                        "policy-mode": "string"
                      }
                    ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "enable": [ null ]
                  },
                  "af-name": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "forward-delay": "integer",
                      "delete-delay": "integer"
                    }
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  }
                }
              ]
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "notifications": [ null ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      },
      "enable": [ null ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "hold-time": "string",
        "interval": "string"
      },
      "disable-quick-start": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "hold-time": "string",
        "interval": "string"
      },
      "disable-instance-tlv": [ null ]
    },
    "ltrace-buf-multiplier": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "max-backoff-time": "integer",
        "initial-backoff-time": "integer"
      }
    },
    "disable-implicit-ipv4": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LDP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/

Create operation of resource: mpls-ldp

mpls-ldp_schema

mpls-ldpbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "enable": [ null ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "on-proc-restart": "integer",
          "on-session-up": "integer"
        }
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "vrf-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "mldp-rib-unicast-always": [ null ],
                  "enable": [ null ],
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "route-policy": "string",
                        "root-address": "string",
                        "policy-mode": "string"
                      }
                    ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "enable": [ null ]
                  },
                  "af-name": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "forward-delay": "integer",
                      "delete-delay": "integer"
                    }
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  }
                }
              ]
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "notifications": [ null ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      },
      "enable": [ null ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "hold-time": "string",
        "interval": "string"
      },
      "disable-quick-start": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "hold-time": "string",
        "interval": "string"
      },
      "disable-instance-tlv": [ null ]
    },
    "ltrace-buf-multiplier": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "max-backoff-time": "integer",
        "initial-backoff-time": "integer"
      }
    },
    "disable-implicit-ipv4": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LDP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/

Delete operation of resource: mpls-ldp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LDP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/

Retrieve operation of resource: mpls-ldp

200 OK
mpls-ldp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "enable": [ null ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "on-proc-restart": "integer",
          "on-session-up": "integer"
        }
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "vrf-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "mldp-rib-unicast-always": [ null ],
                  "enable": [ null ],
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    : [ 
PUT                      POST                     DELETE                    GET                    
                    
                      {
                        "route-policy": "string",
                        "root-address": "string",
                        "policy-mode": "string"
                      }
                    ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "enable": [ null ]
                  },
                  "af-name": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "forward-delay": "integer",
                      "delete-delay": "integer"
                    }
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  },
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "policy": "string",
                    "enable": [ null ]
                  }
                }
              ]
            }
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          "notifications": [ null ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      },
      "enable": [ null ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "hold-time": "string",
        "interval": "string"
      },
      "disable-quick-start": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "hold-time": "string",
        "interval": "string"
      },
      "disable-instance-tlv": [ null ]
    },
    "ltrace-buf-multiplier": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        "max-backoff-time": "integer",
        "initial-backoff-time": "integer"
      }
    },
    "disable-implicit-ipv4": [ null ]
  }
}

DEFAULT-VRF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/

Update operation of resource: default-vrf

default-vrf_schema

default-vrfbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "disable": [ null ],
                  "timeout": "integer"
                }
              }
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "disable-quick-start": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              "dual-stack": "string",
              "interval": "string",
              "hold-time": "string"
            }
          }
        },
        "enable": [ null ],
        "interface-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "af-name": "string",
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                "disable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "address-type": "string",
                  "address": "string"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "disable-auto-config": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "type": "string"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "protection-type": "string",
        "duration": "integer"
      }
    },
    "router-id": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "password": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "tlv-compliance": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          "max-wait": "integer",
          : { 
PUT            POST           DELETE          GET          
          
            "ipv4": [ null ]
          }
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "command-type": "string",
              "password": "string"
            },
            "label-space-id": "integer"
          }
        ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "maintain-on-local-reset": "string"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "targeted": [ null ],
                "ip-address": "string"
              }
            ]
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "group-all": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "mesh-group-id": "string"
                }
              ]
            }
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "transport-address": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "peer-acl-name": "string",
            "accept-type": "string"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "as-xx": "integer",
              "as-yy": "integer"
            },
            : { 
PUT              POST             DELETE            GET            
            
              "peer-acl-name": "string",
              "type": "string"
            }
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "peer-acl-name": "string"
                  }
                ]
              }
            }
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/

Create operation of resource: default-vrf

default-vrf_schema

default-vrfbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "disable": [ null ],
                  "timeout": "integer"
                }
              }
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "disable-quick-start": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              "dual-stack": "string",
              "interval": "string",
              "hold-time": "string"
            }
          }
        },
        "enable": [ null ],
        "interface-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "af-name": "string",
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                "disable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "address-type": "string",
                  "address": "string"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "disable-auto-config": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "type": "string"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "protection-type": "string",
        "duration": "integer"
      }
    },
    "router-id": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "password": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "tlv-compliance": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          "max-wait": "integer",
          : { 
PUT            POST           DELETE          GET          
          
            "ipv4": [ null ]
          }
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "command-type": "string",
              "password": "string"
            },
            "label-space-id": "integer"
          }
        ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "maintain-on-local-reset": "string"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "targeted": [ null ],
                "ip-address": "string"
              }
            ]
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "group-all": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "mesh-group-id": "string"
                }
              ]
            }
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "transport-address": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "peer-acl-name": "string",
            "accept-type": "string"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "as-xx": "integer",
              "as-yy": "integer"
            },
            : { 
PUT              POST             DELETE            GET            
            
              "peer-acl-name": "string",
              "type": "string"
            }
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "peer-acl-name": "string"
                  }
                ]
              }
            }
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/

Delete operation of resource: default-vrf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/

Retrieve operation of resource: default-vrf

200 OK
default-vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "disable": [ null ],
                  "timeout": "integer"
                }
              }
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "disable-quick-start": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              "dual-stack": "string",
              "interval": "string",
              "hold-time": "string"
            }
          }
        },
        "enable": [ null ],
        "interface-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "af-name": "string",
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                "disable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                : { 
PUT                  POST                 DELETE                GET                
                
                  "address-type": "string",
                  "address": "string"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "disable-auto-config": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "type": "string"
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "protection-type": "string",
        "duration": "integer"
      }
    },
    "router-id": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "password": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "tlv-compliance": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          "max-wait": "integer",
          : { 
PUT            POST           DELETE          GET          
          
            "ipv4": [ null ]
          }
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "command-type": "string",
              "password": "string"
            },
            "label-space-id": "integer"
          }
        ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "maintain-on-local-reset": "string"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "targeted": [ null ],
                "ip-address": "string"
              }
            ]
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "group-all": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "mesh-group-id": "string"
                }
              ]
            }
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "transport-address": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "peer-acl-name": "string",
            "accept-type": "string"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              "as-xx": "integer",
              "as-yy": "integer"
            },
            : { 
PUT              POST             DELETE            GET            
            
              "peer-acl-name": "string",
              "type": "string"
            }
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "peer-acl-name": "string"
                  }
                ]
              }
            }
          }
        }
      }
    ]
  }
}

AFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/

Update operation of resource: afs

afs_schema

afsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/

Create operation of resource: afs

afs_schema

afsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/

Delete operation of resource: afs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/

Retrieve operation of resource: afs

200 OK
afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/

Update operation of resource: af

af_schema

afbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/

Create operation of resource: af

af_schema

afbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/

Delete operation of resource: af

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/

Retrieve operation of resource: af

af-name: string
in path

ID of af-name

200 OK
af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}

LABEL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/

Update operation of resource: label

label_schema

labelbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/

Create operation of resource: label

label_schema

labelbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/

Delete operation of resource: label

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/

Retrieve operation of resource: label

af-name: string
in path

ID of af-name

200 OK
label_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}

REMOTE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/

Update operation of resource: remote

remote_schema

remotebody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/

Create operation of resource: remote

remote_schema

remotebody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/

Delete operation of resource: remote

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/

Retrieve operation of resource: remote

af-name: string
in path

ID of af-name

200 OK
remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    }
  }
}

ACCEPT - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/

Update operation of resource: accept

accept_schema

acceptbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCEPT - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/

Create operation of resource: accept

accept_schema

acceptbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCEPT - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/

Delete operation of resource: accept

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCEPT - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/

Retrieve operation of resource: accept

af-name: string
in path

ID of af-name

200 OK
accept_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}

PEER-ACCEPT-POLICIES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Update operation of resource: peer-accept-policies

peer-accept-policies_schema

peer-accept-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICIES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Create operation of resource: peer-accept-policies

peer-accept-policies_schema

peer-accept-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICIES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Delete operation of resource: peer-accept-policies

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICIES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Retrieve operation of resource: peer-accept-policies

af-name: string
in path

ID of af-name

200 OK
peer-accept-policies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

PEER-ACCEPT-POLICY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{lsr-id label-space-id}/

Update operation of resource: peer-accept-policy

peer-accept-policy_schema

peer-accept-policybody object

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{lsr-id label-space-id}/

Create operation of resource: peer-accept-policy

peer-accept-policy_schema

peer-accept-policybody object

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{lsr-id label-space-id}/

Delete operation of resource: peer-accept-policy

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{lsr-id label-space-id}/

Retrieve operation of resource: peer-accept-policy

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK
peer-accept-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

LOCAL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/

Update operation of resource: local

local_schema

localbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/

Create operation of resource: local

local_schema

localbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/

Delete operation of resource: local

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/

Retrieve operation of resource: local

af-name: string
in path

ID of af-name

200 OK
local_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}

ADVERTISE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/

Update operation of resource: advertise

advertise_schema

advertisebody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/

Create operation of resource: advertise

advertise_schema

advertisebody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/

Delete operation of resource: advertise

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/

Retrieve operation of resource: advertise

af-name: string
in path

ID of af-name

200 OK
advertise_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}

PEER-ADVERTISE-POLICIES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Update operation of resource: peer-advertise-policies

peer-advertise-policies_schema

peer-advertise-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICIES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Create operation of resource: peer-advertise-policies

peer-advertise-policies_schema

peer-advertise-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICIES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Delete operation of resource: peer-advertise-policies

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICIES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Retrieve operation of resource: peer-advertise-policies

af-name: string
in path

ID of af-name

200 OK
peer-advertise-policies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

PEER-ADVERTISE-POLICY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{lsr-id label-space-id}/

Update operation of resource: peer-advertise-policy

peer-advertise-policy_schema

peer-advertise-policybody object

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{lsr-id label-space-id}/

Create operation of resource: peer-advertise-policy

peer-advertise-policy_schema

peer-advertise-policybody object

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{lsr-id label-space-id}/

Delete operation of resource: peer-advertise-policy

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{lsr-id label-space-id}/

Retrieve operation of resource: peer-advertise-policy

af-name: string
in path

ID of af-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK
peer-advertise-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

PREFIX-ADVERTISE-POLICIES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/

Update operation of resource: prefix-advertise-policies

prefix-advertise-policies_schema

prefix-advertise-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "peer-acl-name": "string",
      "prefix-acl-name": "string",
      "advertise-type": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFIX-ADVERTISE-POLICIES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/

Create operation of resource: prefix-advertise-policies

prefix-advertise-policies_schema

prefix-advertise-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "peer-acl-name": "string",
      "prefix-acl-name": "string",
      "advertise-type": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFIX-ADVERTISE-POLICIES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/

Delete operation of resource: prefix-advertise-policies

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFIX-ADVERTISE-POLICIES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/

Retrieve operation of resource: prefix-advertise-policies

af-name: string
in path

ID of af-name

200 OK
prefix-advertise-policies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "peer-acl-name": "string",
      "prefix-acl-name": "string",
      "advertise-type": "string"
    }
  ]
}

PREFIX-ADVERTISE-POLICY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/prefix-advertise-policy/{prefix-acl-name}/

Update operation of resource: prefix-advertise-policy

prefix-advertise-policy_schema

prefix-advertise-policybody object

af-name: string
in path

ID of af-name

prefix-acl-name: string
in path

ID of prefix-acl-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "prefix-acl-name": "string",
  "advertise-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFIX-ADVERTISE-POLICY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/prefix-advertise-policy/{prefix-acl-name}/

Create operation of resource: prefix-advertise-policy

prefix-advertise-policy_schema

prefix-advertise-policybody object

af-name: string
in path

ID of af-name

prefix-acl-name: string
in path

ID of prefix-acl-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "prefix-acl-name": "string",
  "advertise-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFIX-ADVERTISE-POLICY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/prefix-advertise-policy/{prefix-acl-name}/

Delete operation of resource: prefix-advertise-policy

af-name: string
in path

ID of af-name

prefix-acl-name: string
in path

ID of prefix-acl-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFIX-ADVERTISE-POLICY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/prefix-advertise-policies/prefix-advertise-policy/{prefix-acl-name}/

Retrieve operation of resource: prefix-advertise-policy

af-name: string
in path

ID of af-name

prefix-acl-name: string
in path

ID of prefix-acl-name

200 OK
prefix-advertise-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "prefix-acl-name": "string",
  "advertise-type": "string"
}

EXPLICIT-NULL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/explicit-null/

Update operation of resource: explicit-null

explicit-null_schema

explicit-nullbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-NULL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/explicit-null/

Create operation of resource: explicit-null

explicit-null_schema

explicit-nullbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-NULL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/explicit-null/

Delete operation of resource: explicit-null

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-NULL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/explicit-null/

Retrieve operation of resource: explicit-null

af-name: string
in path

ID of af-name

200 OK
explicit-null_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}

INTERFACES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/

Delete operation of resource: interfaces

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/

Retrieve operation of resource: interfaces

af-name: string
in path

ID of af-name

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}

INTERFACE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Delete operation of resource: interface

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}

ALLOCATE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/allocate/

Update operation of resource: allocate

allocate_schema

allocatebody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/allocate/

Create operation of resource: allocate

allocate_schema

allocatebody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/allocate/

Delete operation of resource: allocate

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/label/local/allocate/

Retrieve operation of resource: allocate

af-name: string
in path

ID of af-name

200 OK
allocate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}

DISCOVERY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/

Update operation of resource: discovery

discovery_schema

discoverybody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/

Create operation of resource: discovery

discovery_schema

discoverybody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/

Delete operation of resource: discovery

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/

Retrieve operation of resource: discovery

af-name: string
in path

ID of af-name

200 OK
discovery_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

TARGETED-HELLO-ACCEPT - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/targeted-hello-accept/

Update operation of resource: targeted-hello-accept

targeted-hello-accept_schema

targeted-hello-acceptbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "accept-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETED-HELLO-ACCEPT - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/targeted-hello-accept/

Create operation of resource: targeted-hello-accept

targeted-hello-accept_schema

targeted-hello-acceptbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "accept-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETED-HELLO-ACCEPT - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/targeted-hello-accept/

Delete operation of resource: targeted-hello-accept

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETED-HELLO-ACCEPT - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/discovery/targeted-hello-accept/

Retrieve operation of resource: targeted-hello-accept

af-name: string
in path

ID of af-name

200 OK
targeted-hello-accept_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "accept-type": "string"
}

TRAFFIC-ENGINEERING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/

Update operation of resource: traffic-engineering

traffic-engineering_schema

traffic-engineeringbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "group-all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mesh-group-id": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/

Create operation of resource: traffic-engineering

traffic-engineering_schema

traffic-engineeringbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "group-all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mesh-group-id": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/

Delete operation of resource: traffic-engineering

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/

Retrieve operation of resource: traffic-engineering

af-name: string
in path

ID of af-name

200 OK
traffic-engineering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "group-all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mesh-group-id": "string"
        }
      ]
    }
  }
}

AUTO-TUNNEL-MESH - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/

Update operation of resource: auto-tunnel-mesh

auto-tunnel-mesh_schema

auto-tunnel-meshbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "group-all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mesh-group-id": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-TUNNEL-MESH - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/

Create operation of resource: auto-tunnel-mesh

auto-tunnel-mesh_schema

auto-tunnel-meshbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "group-all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mesh-group-id": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-TUNNEL-MESH - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/

Delete operation of resource: auto-tunnel-mesh

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTO-TUNNEL-MESH - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/

Retrieve operation of resource: auto-tunnel-mesh

af-name: string
in path

ID of af-name

200 OK
auto-tunnel-mesh_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "group-all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mesh-group-id": "string"
      }
    ]
  }
}

GROUP-IDS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/

Update operation of resource: group-ids

group-ids_schema

group-idsbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mesh-group-id": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-IDS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/

Create operation of resource: group-ids

group-ids_schema

group-idsbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mesh-group-id": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-IDS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/

Delete operation of resource: group-ids

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-IDS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/

Retrieve operation of resource: group-ids

af-name: string
in path

ID of af-name

200 OK
group-ids_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mesh-group-id": "string"
    }
  ]
}

GROUP-ID - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/group-id/{mesh-group-id}/

Update operation of resource: group-id

group-id_schema

group-idbody object

af-name: string
in path

ID of af-name

mesh-group-id: string
in path

ID of mesh-group-id

Request Content-Types: application/json
Request Example
{
  "mesh-group-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-ID - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/group-id/{mesh-group-id}/

Create operation of resource: group-id

group-id_schema

group-idbody object

af-name: string
in path

ID of af-name

mesh-group-id: string
in path

ID of mesh-group-id

Request Content-Types: application/json
Request Example
{
  "mesh-group-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-ID - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/group-id/{mesh-group-id}/

Delete operation of resource: group-id

af-name: string
in path

ID of af-name

mesh-group-id: string
in path

ID of mesh-group-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP-ID - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/traffic-engineering/auto-tunnel-mesh/group-ids/group-id/{mesh-group-id}/

Retrieve operation of resource: group-id

af-name: string
in path

ID of af-name

mesh-group-id: string
in path

ID of mesh-group-id

200 OK
group-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mesh-group-id": "string"
}

NEIGHBOR - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/

Update operation of resource: neighbor

neighbor_schema

neighborbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/

Create operation of resource: neighbor

neighbor_schema

neighborbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/

Delete operation of resource: neighbor

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/

Retrieve operation of resource: neighbor

af-name: string
in path

ID of af-name

200 OK
neighbor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}

ADDRESSES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/

Update operation of resource: addresses

addresses_schema

addressesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "targeted": [ null ],
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESSES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/

Create operation of resource: addresses

addresses_schema

addressesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "targeted": [ null ],
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESSES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/

Delete operation of resource: addresses

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESSES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/

Retrieve operation of resource: addresses

af-name: string
in path

ID of af-name

200 OK
addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "targeted": [ null ],
      "ip-address": "string"
    }
  ]
}

ADDRESS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/address/{ip-address}/

Update operation of resource: address

address_schema

addressbody object

af-name: string
in path

ID of af-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "targeted": [ null ],
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/address/{ip-address}/

Create operation of resource: address

address_schema

addressbody object

af-name: string
in path

ID of af-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "targeted": [ null ],
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/address/{ip-address}/

Delete operation of resource: address

af-name: string
in path

ID of af-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/neighbor/addresses/address/{ip-address}/

Retrieve operation of resource: address

af-name: string
in path

ID of af-name

ip-address: string
in path

ID of ip-address

200 OK
address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "targeted": [ null ],
  "ip-address": "string"
}

REDISTRIBUTION-PROTOCOL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/

Update operation of resource: redistribution-protocol

redistribution-protocol_schema

redistribution-protocolbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "as-xx": "integer",
      "as-yy": "integer"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "type": "string"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REDISTRIBUTION-PROTOCOL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/

Create operation of resource: redistribution-protocol

redistribution-protocol_schema

redistribution-protocolbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "as-xx": "integer",
      "as-yy": "integer"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "type": "string"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REDISTRIBUTION-PROTOCOL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/

Delete operation of resource: redistribution-protocol

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REDISTRIBUTION-PROTOCOL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/

Retrieve operation of resource: redistribution-protocol

af-name: string
in path

ID of af-name

200 OK
redistribution-protocol_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "as-xx": "integer",
      "as-yy": "integer"
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "type": "string"
    }
  }
}

BGP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/

Update operation of resource: bgp

bgp_schema

bgpbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "as-xx": "integer",
    "as-yy": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "type": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/

Create operation of resource: bgp

bgp_schema

bgpbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "as-xx": "integer",
    "as-yy": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "type": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/

Delete operation of resource: bgp

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BGP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/

Retrieve operation of resource: bgp

af-name: string
in path

ID of af-name

200 OK
bgp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "as-xx": "integer",
    "as-yy": "integer"
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "type": "string"
  }
}

AS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/as/

Update operation of resource: as

as_schema

asbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "as-xx": "integer",
  "as-yy": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/as/

Create operation of resource: as

as_schema

asbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "as-xx": "integer",
  "as-yy": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/as/

Delete operation of resource: as

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/as/

Retrieve operation of resource: as

af-name: string
in path

ID of af-name

200 OK
as_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "as-xx": "integer",
  "as-yy": "integer"
}

ADVERTISE-TO - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/advertise-to/

Update operation of resource: advertise-to

advertise-to_schema

advertise-tobody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-TO - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/advertise-to/

Create operation of resource: advertise-to

advertise-to_schema

advertise-tobody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-TO - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/advertise-to/

Delete operation of resource: advertise-to

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE-TO - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/afs/af/{af-name}/redistribution-protocol/bgp/advertise-to/

Retrieve operation of resource: advertise-to

af-name: string
in path

ID of af-name

200 OK
advertise-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "type": "string"
}

GLOBAL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/

Update operation of resource: global

global_schema

globalbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/

Create operation of resource: global

global_schema

globalbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/

Delete operation of resource: global

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/

Retrieve operation of resource: global

200 OK
global_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}

SESSION - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/

Update operation of resource: session

session_schema

sessionbody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/

Create operation of resource: session

session_schema

sessionbody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/

Delete operation of resource: session

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/

Retrieve operation of resource: session

200 OK
session_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}

PROTECTION - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/protection/

Update operation of resource: protection

protection_schema

protectionbody object

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "protection-type": "string",
  "duration": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROTECTION - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/protection/

Create operation of resource: protection

protection_schema

protectionbody object

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "protection-type": "string",
  "duration": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROTECTION - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/protection/

Delete operation of resource: protection

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROTECTION - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/protection/

Retrieve operation of resource: protection

200 OK
protection_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "protection-type": "string",
  "duration": "integer"
}

DOWNSTREAM-ON-DEMAND - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/downstream-on-demand/

Update operation of resource: downstream-on-demand

downstream-on-demand_schema

downstream-on-demandbody object

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOWNSTREAM-ON-DEMAND - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/downstream-on-demand/

Create operation of resource: downstream-on-demand

downstream-on-demand_schema

downstream-on-demandbody object

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOWNSTREAM-ON-DEMAND - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/downstream-on-demand/

Delete operation of resource: downstream-on-demand

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOWNSTREAM-ON-DEMAND - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/session/downstream-on-demand/

Retrieve operation of resource: downstream-on-demand

200 OK
downstream-on-demand_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "type": "string"
}

NEIGHBOR - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/

Update operation of resource: neighbor

neighbor_schema

neighborbody object

Request Content-Types: application/json
Request Example
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/

Create operation of resource: neighbor

neighbor_schema

neighborbody object

Request Content-Types: application/json
Request Example
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/

Delete operation of resource: neighbor

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/

Retrieve operation of resource: neighbor

200 OK
neighbor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}

LDP-IDS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/

Update operation of resource: ldp-ids

ldp-ids_schema

ldp-idsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-IDS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/

Create operation of resource: ldp-ids

ldp-ids_schema

ldp-idsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-IDS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/

Delete operation of resource: ldp-ids

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-IDS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/

Retrieve operation of resource: ldp-ids

200 OK
ldp-ids_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}

LDP-ID - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Update operation of resource: ldp-id

ldp-id_schema

ldp-idbody object

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-ID - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Create operation of resource: ldp-id

ldp-id_schema

ldp-idbody object

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-ID - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Delete operation of resource: ldp-id

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-ID - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Retrieve operation of resource: ldp-id

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK
ldp-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "lsr-id": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}

PASSWORD - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Update operation of resource: password

password_schema

passwordbody object

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "command-type": "string",
  "password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Create operation of resource: password

password_schema

passwordbody object

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "command-type": "string",
  "password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Delete operation of resource: password

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Retrieve operation of resource: password

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK
password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "command-type": "string",
  "password": "string"
}

DUAL-STACK - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/

Update operation of resource: dual-stack

dual-stack_schema

dual-stackbody object

Request Content-Types: application/json
Request Example
{
  "tlv-compliance": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "max-wait": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "ipv4": [ null ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUAL-STACK - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/

Create operation of resource: dual-stack

dual-stack_schema

dual-stackbody object

Request Content-Types: application/json
Request Example
{
  "tlv-compliance": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "max-wait": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "ipv4": [ null ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUAL-STACK - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/

Delete operation of resource: dual-stack

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUAL-STACK - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/

Retrieve operation of resource: dual-stack

200 OK
dual-stack_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "tlv-compliance": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "max-wait": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "ipv4": [ null ]
    }
  }
}

TRANSPORT-CONNECTION - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/

Update operation of resource: transport-connection

transport-connection_schema

transport-connectionbody object

Request Content-Types: application/json
Request Example
{
  "max-wait": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "ipv4": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-CONNECTION - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/

Create operation of resource: transport-connection

transport-connection_schema

transport-connectionbody object

Request Content-Types: application/json
Request Example
{
  "max-wait": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "ipv4": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-CONNECTION - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/

Delete operation of resource: transport-connection

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-CONNECTION - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/

Retrieve operation of resource: transport-connection

200 OK
transport-connection_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "max-wait": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "ipv4": [ null ]
  }
}

PREFER - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/prefer/

Update operation of resource: prefer

prefer_schema

preferbody object

Request Content-Types: application/json
Request Example
{
  "ipv4": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFER - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/prefer/

Create operation of resource: prefer

prefer_schema

preferbody object

Request Content-Types: application/json
Request Example
{
  "ipv4": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFER - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/prefer/

Delete operation of resource: prefer

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PREFER - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/neighbor/dual-stack/transport-connection/prefer/

Retrieve operation of resource: prefer

200 OK
prefer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ipv4": [ null ]
}

GRACEFUL-RESTART - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/

Update operation of resource: graceful-restart

graceful-restart_schema

graceful-restartbody object

Request Content-Types: application/json
Request Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/

Create operation of resource: graceful-restart

graceful-restart_schema

graceful-restartbody object

Request Content-Types: application/json
Request Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/

Delete operation of resource: graceful-restart

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/

Retrieve operation of resource: graceful-restart

200 OK
graceful-restart_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}

HELPER-PEER - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/helper-peer/

Update operation of resource: helper-peer

helper-peer_schema

helper-peerbody object

Request Content-Types: application/json
Request Example
{
  "maintain-on-local-reset": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-PEER - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/helper-peer/

Create operation of resource: helper-peer

helper-peer_schema

helper-peerbody object

Request Content-Types: application/json
Request Example
{
  "maintain-on-local-reset": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-PEER - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/helper-peer/

Delete operation of resource: helper-peer

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-PEER - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/global/graceful-restart/helper-peer/

Retrieve operation of resource: helper-peer

200 OK
helper-peer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "maintain-on-local-reset": "string"
}

INTERFACES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/

Retrieve operation of resource: interfaces

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}

INTERFACE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}

AFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/

Update operation of resource: afs

afs_schema

afsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/

Create operation of resource: afs

afs_schema

afsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/

Delete operation of resource: afs

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/

Retrieve operation of resource: afs

interface-name: string
in path

ID of interface-name

200 OK
afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/

Update operation of resource: af

af_schema

afbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/

Create operation of resource: af

af_schema

afbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/

Delete operation of resource: af

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/

Retrieve operation of resource: af

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}

DISCOVERY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Update operation of resource: discovery

discovery_schema

discoverybody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Create operation of resource: discovery

discovery_schema

discoverybody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Delete operation of resource: discovery

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Retrieve operation of resource: discovery

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
discovery_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

TRANSPORT-ADDRESS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Update operation of resource: transport-address

transport-address_schema

transport-addressbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "address-type": "string",
  "address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-ADDRESS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Create operation of resource: transport-address

transport-address_schema

transport-addressbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "address-type": "string",
  "address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-ADDRESS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Delete operation of resource: transport-address

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-ADDRESS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Retrieve operation of resource: transport-address

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
transport-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "address-type": "string",
  "address": "string"
}

IGP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/igp/

Update operation of resource: igp

igp_schema

igpbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/igp/

Create operation of resource: igp

igp_schema

igpbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/igp/

Delete operation of resource: igp

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/igp/

Retrieve operation of resource: igp

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
igp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}

MLDP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/mldp/

Update operation of resource: mldp

mldp_schema

mldpbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "notifications": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "enable": [ null ]
          },
          "af-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/mldp/

Create operation of resource: mldp

mldp_schema

mldpbody object

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "notifications": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "enable": [ null ]
          },
          "af-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/mldp/

Delete operation of resource: mldp

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/afs/af/{af-name}/mldp/

Retrieve operation of resource: mldp

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
mldp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "notifications": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "enable": [ null ]
          },
          "af-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}

GLOBAL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/

Update operation of resource: global

global_schema

globalbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/

Create operation of resource: global

global_schema

globalbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/

Delete operation of resource: global

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/

Retrieve operation of resource: global

interface-name: string
in path

ID of interface-name

200 OK
global_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}

DISCOVERY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/

Update operation of resource: discovery

discovery_schema

discoverybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/

Create operation of resource: discovery

discovery_schema

discoverybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/

Delete operation of resource: discovery

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/

Retrieve operation of resource: discovery

interface-name: string
in path

ID of interface-name

200 OK
discovery_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

LINK-HELLO - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/link-hello/

Update operation of resource: link-hello

link-hello_schema

link-hellobody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "hold-time": "string",
  "interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-HELLO - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/link-hello/

Create operation of resource: link-hello

link-hello_schema

link-hellobody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "hold-time": "string",
  "interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-HELLO - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/link-hello/

Delete operation of resource: link-hello

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-HELLO - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/discovery/link-hello/

Retrieve operation of resource: link-hello

interface-name: string
in path

ID of interface-name

200 OK
link-hello_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "hold-time": "string",
  "interval": "string"
}

IGP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/

Update operation of resource: igp

igp_schema

igpbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/

Create operation of resource: igp

igp_schema

igpbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/

Delete operation of resource: igp

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/

Retrieve operation of resource: igp

interface-name: string
in path

ID of interface-name

200 OK
igp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}

SYNC - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/

Update operation of resource: sync

sync_schema

syncbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYNC - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/

Create operation of resource: sync

sync_schema

syncbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYNC - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/

Delete operation of resource: sync

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYNC - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/

Retrieve operation of resource: sync

interface-name: string
in path

ID of interface-name

200 OK
sync_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}

DELAY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/

Update operation of resource: delay

delay_schema

delaybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/

Create operation of resource: delay

delay_schema

delaybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/

Delete operation of resource: delay

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/

Retrieve operation of resource: delay

interface-name: string
in path

ID of interface-name

200 OK
delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}

ON-SESSION-UP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/on-session-up/

Update operation of resource: on-session-up

on-session-up_schema

on-session-upbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "disable": [ null ],
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ON-SESSION-UP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/on-session-up/

Create operation of resource: on-session-up

on-session-up_schema

on-session-upbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "disable": [ null ],
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ON-SESSION-UP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/on-session-up/

Delete operation of resource: on-session-up

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ON-SESSION-UP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/default-vrf/interfaces/interface/{interface-name}/global/igp/sync/delay/on-session-up/

Retrieve operation of resource: on-session-up

interface-name: string
in path

ID of interface-name

200 OK
on-session-up_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "disable": [ null ],
  "timeout": "integer"
}

VRFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/

Retrieve operation of resource: vrfs

200 OK
vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK
vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}

GLOBAL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/

Update operation of resource: global

global_schema

globalbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/

Create operation of resource: global

global_schema

globalbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/

Delete operation of resource: global

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/

Retrieve operation of resource: global

vrf-name: string
in path

ID of vrf-name

200 OK
global_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}

SESSION - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/

Update operation of resource: session

session_schema

sessionbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/

Create operation of resource: session

session_schema

sessionbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/

Delete operation of resource: session

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/

Retrieve operation of resource: session

vrf-name: string
in path

ID of vrf-name

200 OK
session_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}

DOWNSTREAM-ON-DEMAND - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/downstream-on-demand/

Update operation of resource: downstream-on-demand

downstream-on-demand_schema

downstream-on-demandbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOWNSTREAM-ON-DEMAND - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/downstream-on-demand/

Create operation of resource: downstream-on-demand

downstream-on-demand_schema

downstream-on-demandbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOWNSTREAM-ON-DEMAND - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/downstream-on-demand/

Delete operation of resource: downstream-on-demand

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DOWNSTREAM-ON-DEMAND - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/session/downstream-on-demand/

Retrieve operation of resource: downstream-on-demand

vrf-name: string
in path

ID of vrf-name

200 OK
downstream-on-demand_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "type": "string"
}

NEIGHBOR - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/

Update operation of resource: neighbor

neighbor_schema

neighborbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/

Create operation of resource: neighbor

neighbor_schema

neighborbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/

Delete operation of resource: neighbor

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/

Retrieve operation of resource: neighbor

vrf-name: string
in path

ID of vrf-name

200 OK
neighbor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "password": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "lsr-id": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}

LDP-IDS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/

Update operation of resource: ldp-ids

ldp-ids_schema

ldp-idsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-IDS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/

Create operation of resource: ldp-ids

ldp-ids_schema

ldp-idsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-IDS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/

Delete operation of resource: ldp-ids

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-IDS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/

Retrieve operation of resource: ldp-ids

vrf-name: string
in path

ID of vrf-name

200 OK
ldp-ids_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}

LDP-ID - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Update operation of resource: ldp-id

ldp-id_schema

ldp-idbody object

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-ID - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Create operation of resource: ldp-id

ldp-id_schema

ldp-idbody object

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-ID - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Delete operation of resource: ldp-id

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LDP-ID - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/

Retrieve operation of resource: ldp-id

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK
ldp-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "lsr-id": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}

PASSWORD - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Update operation of resource: password

password_schema

passwordbody object

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "command-type": "string",
  "password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Create operation of resource: password

password_schema

passwordbody object

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

Request Content-Types: application/json
Request Example
{
  "command-type": "string",
  "password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Delete operation of resource: password

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSWORD - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/neighbor/ldp-ids/ldp-id/{lsr-id label-space-id}/password/

Retrieve operation of resource: password

vrf-name: string
in path

ID of vrf-name

lsr-id label-space-id: string
in path

ID of lsr-id label-space-id

200 OK
password_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "command-type": "string",
  "password": "string"
}

GRACEFUL-RESTART - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/

Update operation of resource: graceful-restart

graceful-restart_schema

graceful-restartbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/

Create operation of resource: graceful-restart

graceful-restart_schema

graceful-restartbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/

Delete operation of resource: graceful-restart

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/

Retrieve operation of resource: graceful-restart

vrf-name: string
in path

ID of vrf-name

200 OK
graceful-restart_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}

HELPER-PEER - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/helper-peer/

Update operation of resource: helper-peer

helper-peer_schema

helper-peerbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "maintain-on-local-reset": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-PEER - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/helper-peer/

Create operation of resource: helper-peer

helper-peer_schema

helper-peerbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "maintain-on-local-reset": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-PEER - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/helper-peer/

Delete operation of resource: helper-peer

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-PEER - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/global/graceful-restart/helper-peer/

Retrieve operation of resource: helper-peer

vrf-name: string
in path

ID of vrf-name

200 OK
helper-peer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "maintain-on-local-reset": "string"
}

AFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/

Update operation of resource: afs

afs_schema

afsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/

Create operation of resource: afs

afs_schema

afsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/

Delete operation of resource: afs

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/

Retrieve operation of resource: afs

vrf-name: string
in path

ID of vrf-name

200 OK
afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Update operation of resource: af

af_schema

afbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Create operation of resource: af

af_schema

afbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Delete operation of resource: af

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Retrieve operation of resource: af

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}

DISCOVERY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/discovery/

Update operation of resource: discovery

discovery_schema

discoverybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/discovery/

Create operation of resource: discovery

discovery_schema

discoverybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/discovery/

Delete operation of resource: discovery

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/discovery/

Retrieve operation of resource: discovery

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
discovery_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

LABEL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/

Update operation of resource: label

label_schema

labelbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/

Create operation of resource: label

label_schema

labelbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/

Delete operation of resource: label

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/

Retrieve operation of resource: label

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
label_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}

REMOTE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/

Update operation of resource: remote

remote_schema

remotebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/

Create operation of resource: remote

remote_schema

remotebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/

Delete operation of resource: remote

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/

Retrieve operation of resource: remote

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    }
  }
}

ACCEPT - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/

Update operation of resource: accept

accept_schema

acceptbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCEPT - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/

Create operation of resource: accept

accept_schema

acceptbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCEPT - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/

Delete operation of resource: accept

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCEPT - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/

Retrieve operation of resource: accept

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
accept_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}

PEER-ACCEPT-POLICIES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Update operation of resource: peer-accept-policies

peer-accept-policies_schema

peer-accept-policiesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICIES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Create operation of resource: peer-accept-policies

peer-accept-policies_schema

peer-accept-policiesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICIES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Delete operation of resource: peer-accept-policies

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICIES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/

Retrieve operation of resource: peer-accept-policies

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
peer-accept-policies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

PEER-ACCEPT-POLICY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/

Update operation of resource: peer-accept-policy

peer-accept-policy_schema

peer-accept-policybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/

Create operation of resource: peer-accept-policy

peer-accept-policy_schema

peer-accept-policybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/

Delete operation of resource: peer-accept-policy

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/

Retrieve operation of resource: peer-accept-policy

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK
peer-accept-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

PEER-ACCEPT-POLICY-DATA - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/peer-accept-policy-data/

Update operation of resource: peer-accept-policy-data

PEER-ACCEPT-POLICY-CONTENT

peer-accept-policy-databody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY-DATA - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/peer-accept-policy-data/

Create operation of resource: peer-accept-policy-data

PEER-ACCEPT-POLICY-CONTENT

peer-accept-policy-databody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY-DATA - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/peer-accept-policy-data/

Delete operation of resource: peer-accept-policy-data

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ACCEPT-POLICY-DATA - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/peer-accept-policy-data/

Retrieve operation of resource: peer-accept-policy-data

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK
PEER-ACCEPT-POLICY-CONTENT

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)

LSR-ID - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/lsr-id/{lsr-id}/

Update operation of resource: lsr-id

lsr-id_schema

lsr-idbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-ID - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/lsr-id/{lsr-id}/

Create operation of resource: lsr-id

lsr-id_schema

lsr-idbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-ID - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/lsr-id/{lsr-id}/

Delete operation of resource: lsr-id

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-ID - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/remote/accept/peer-accept-policies/peer-accept-policy/{label-space-id}/lsr-id/{lsr-id}/

Retrieve operation of resource: lsr-id

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

200 OK
lsr-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "lsr-id": "string"
}

LOCAL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/

Update operation of resource: local

local_schema

localbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/

Create operation of resource: local

local_schema

localbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/

Delete operation of resource: local

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOCAL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/

Retrieve operation of resource: local

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
local_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}

ADVERTISE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/

Update operation of resource: advertise

advertise_schema

advertisebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/

Create operation of resource: advertise

advertise_schema

advertisebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/

Delete operation of resource: advertise

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADVERTISE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/

Retrieve operation of resource: advertise

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
advertise_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}

PEER-ADVERTISE-POLICIES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Update operation of resource: peer-advertise-policies

peer-advertise-policies_schema

peer-advertise-policiesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICIES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Create operation of resource: peer-advertise-policies

peer-advertise-policies_schema

peer-advertise-policiesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICIES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Delete operation of resource: peer-advertise-policies

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICIES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/

Retrieve operation of resource: peer-advertise-policies

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
peer-advertise-policies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

PEER-ADVERTISE-POLICY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/

Update operation of resource: peer-advertise-policy

peer-advertise-policy_schema

peer-advertise-policybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/

Create operation of resource: peer-advertise-policy

peer-advertise-policy_schema

peer-advertise-policybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/

Delete operation of resource: peer-advertise-policy

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/

Retrieve operation of resource: peer-advertise-policy

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK
peer-advertise-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

PEER-ADVERTISE-POLICY-DATA - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/peer-advertise-policy-data/

Update operation of resource: peer-advertise-policy-data

PEER-ADVERTISE-POLICY-CONTENT

peer-advertise-policy-databody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY-DATA - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/peer-advertise-policy-data/

Create operation of resource: peer-advertise-policy-data

PEER-ADVERTISE-POLICY-CONTENT

peer-advertise-policy-databody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY-DATA - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/peer-advertise-policy-data/

Delete operation of resource: peer-advertise-policy-data

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-ADVERTISE-POLICY-DATA - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/peer-advertise-policy-data/

Retrieve operation of resource: peer-advertise-policy-data

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

200 OK
PEER-ADVERTISE-POLICY-CONTENT

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)

LSR-ID - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/lsr-id/{lsr-id}/

Update operation of resource: lsr-id

lsr-id_schema

lsr-idbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-ID - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/lsr-id/{lsr-id}/

Create operation of resource: lsr-id

lsr-id_schema

lsr-idbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

Request Content-Types: application/json
Request Example
{
  "lsr-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-ID - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/lsr-id/{lsr-id}/

Delete operation of resource: lsr-id

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-ID - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/peer-advertise-policies/peer-advertise-policy/{label-space-id}/lsr-id/{lsr-id}/

Retrieve operation of resource: lsr-id

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

label-space-id: string
in path

ID of label-space-id

lsr-id: string
in path

ID of lsr-id

200 OK
lsr-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "lsr-id": "string"
}

INTERFACES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/

Delete operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/

Retrieve operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}

INTERFACE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Delete operation of resource: interface

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}

EXPLICIT-NULL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/explicit-null/

Update operation of resource: explicit-null

explicit-null_schema

explicit-nullbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-NULL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/explicit-null/

Create operation of resource: explicit-null

explicit-null_schema

explicit-nullbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-NULL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/explicit-null/

Delete operation of resource: explicit-null

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-NULL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/advertise/explicit-null/

Retrieve operation of resource: explicit-null

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
explicit-null_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}

ALLOCATE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/allocate/

Update operation of resource: allocate

allocate_schema

allocatebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/allocate/

Create operation of resource: allocate

allocate_schema

allocatebody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/allocate/

Delete operation of resource: allocate

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ALLOCATE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/label/local/allocate/

Retrieve operation of resource: allocate

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
allocate_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}

INTERFACES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/

Delete operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/

Retrieve operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "enable": [ null ],
      "interface-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "af-name": "string",
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}

INTERFACE - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Delete operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ],
  "interface-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "af-name": "string",
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : { 
PUT            POST           DELETE          GET          
          
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}

AFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/

Update operation of resource: afs

afs_schema

afsbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/

Create operation of resource: afs

afs_schema

afsbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/

Delete operation of resource: afs

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/

Retrieve operation of resource: afs

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/

Update operation of resource: af

af_schema

afbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/

Create operation of resource: af

af_schema

afbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/

Delete operation of resource: af

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/

Retrieve operation of resource: af

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}

DISCOVERY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Update operation of resource: discovery

discovery_schema

discoverybody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Create operation of resource: discovery

discovery_schema

discoverybody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Delete operation of resource: discovery

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/

Retrieve operation of resource: discovery

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
discovery_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

TRANSPORT-ADDRESS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Update operation of resource: transport-address

transport-address_schema

transport-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "address-type": "string",
  "address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-ADDRESS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Create operation of resource: transport-address

transport-address_schema

transport-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "address-type": "string",
  "address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-ADDRESS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Delete operation of resource: transport-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSPORT-ADDRESS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/afs/af/{af-name}/discovery/transport-address/

Retrieve operation of resource: transport-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

af-name: string
in path

ID of af-name

200 OK
transport-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "address-type": "string",
  "address": "string"
}

GLOBAL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/

Update operation of resource: global

global_schema

globalbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/

Create operation of resource: global

global_schema

globalbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/

Delete operation of resource: global

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/

Retrieve operation of resource: global

200 OK
global_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "vrf-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                : { 
PUT                  POST                 DELETE                GET                
                
                  : [ 
PUT                    POST                   DELETE                  GET                  
                  
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "enable": [ null ]
                },
                "af-name": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                },
                : { 
PUT                  POST                 DELETE                GET                
                
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        "notifications": [ null ]
      }
    },
    : { 
PUT      POST     DELETE    GET    
    
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "dscp": "string"
  }
}

ENTROPY-LABEL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/entropy-label/

Update operation of resource: entropy-label

entropy-label_schema

entropy-labelbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENTROPY-LABEL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/entropy-label/

Create operation of resource: entropy-label

entropy-label_schema

entropy-labelbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENTROPY-LABEL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/entropy-label/

Delete operation of resource: entropy-label

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENTROPY-LABEL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/entropy-label/

Retrieve operation of resource: entropy-label

200 OK
entropy-label_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ]
}

SESSION - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/

Update operation of resource: session

session_schema

sessionbody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/

Create operation of resource: session

session_schema

sessionbody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/

Delete operation of resource: session

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/

Retrieve operation of resource: session

200 OK
session_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "hold-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}

BACKOFF-TIME - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/backoff-time/

Update operation of resource: backoff-time

backoff-time_schema

backoff-timebody object

Request Content-Types: application/json
Request Example
{
  "max-backoff-time": "integer",
  "initial-backoff-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BACKOFF-TIME - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/backoff-time/

Create operation of resource: backoff-time

backoff-time_schema

backoff-timebody object

Request Content-Types: application/json
Request Example
{
  "max-backoff-time": "integer",
  "initial-backoff-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BACKOFF-TIME - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/backoff-time/

Delete operation of resource: backoff-time

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BACKOFF-TIME - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/session/backoff-time/

Retrieve operation of resource: backoff-time

200 OK
backoff-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "max-backoff-time": "integer",
  "initial-backoff-time": "integer"
}

IGP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/

Update operation of resource: igp

igp_schema

igpbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/

Create operation of resource: igp

igp_schema

igpbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/

Delete operation of resource: igp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/

Retrieve operation of resource: igp

200 OK
igp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}

SYNC - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/

Update operation of resource: sync

sync_schema

syncbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYNC - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/

Create operation of resource: sync

sync_schema

syncbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYNC - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/

Delete operation of resource: sync

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYNC - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/

Retrieve operation of resource: sync

200 OK
sync_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}

DELAY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/delay/

Update operation of resource: delay

delay_schema

delaybody object

Request Content-Types: application/json
Request Example
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/delay/

Create operation of resource: delay

delay_schema

delaybody object

Request Content-Types: application/json
Request Example
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/delay/

Delete operation of resource: delay

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/igp/sync/delay/

Retrieve operation of resource: delay

200 OK
delay_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}

ENABLE-LOGGING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/enable-logging/

Update operation of resource: enable-logging

enable-logging_schema

enable-loggingbody object

Request Content-Types: application/json
Request Example
{
  "nsr": [ null ],
  "adjacency": [ null ],
  "session-protection": [ null ],
  "neighbor-changes": [ null ],
  "gr-session-changes": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENABLE-LOGGING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/enable-logging/

Create operation of resource: enable-logging

enable-logging_schema

enable-loggingbody object

Request Content-Types: application/json
Request Example
{
  "nsr": [ null ],
  "adjacency": [ null ],
  "session-protection": [ null ],
  "neighbor-changes": [ null ],
  "gr-session-changes": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENABLE-LOGGING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/enable-logging/

Delete operation of resource: enable-logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENABLE-LOGGING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/enable-logging/

Retrieve operation of resource: enable-logging

200 OK
enable-logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "nsr": [ null ],
  "adjacency": [ null ],
  "session-protection": [ null ],
  "neighbor-changes": [ null ],
  "gr-session-changes": [ null ]
}

SIGNALLING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/signalling/

Update operation of resource: signalling

signalling_schema

signallingbody object

Request Content-Types: application/json
Request Example
{
  "dscp": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALLING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/signalling/

Create operation of resource: signalling

signalling_schema

signallingbody object

Request Content-Types: application/json
Request Example
{
  "dscp": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALLING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/signalling/

Delete operation of resource: signalling

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALLING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/signalling/

Retrieve operation of resource: signalling

200 OK
signalling_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "dscp": "string"
}

NSR - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/nsr/

Update operation of resource: nsr

nsr_schema

nsrbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSR - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/nsr/

Create operation of resource: nsr

nsr_schema

nsrbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSR - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/nsr/

Delete operation of resource: nsr

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSR - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/nsr/

Retrieve operation of resource: nsr

200 OK
nsr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ]
}

GRACEFUL-RESTART - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/graceful-restart/

Update operation of resource: graceful-restart

graceful-restart_schema

graceful-restartbody object

Request Content-Types: application/json
Request Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/graceful-restart/

Create operation of resource: graceful-restart

graceful-restart_schema

graceful-restartbody object

Request Content-Types: application/json
Request Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/graceful-restart/

Delete operation of resource: graceful-restart

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GRACEFUL-RESTART - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/graceful-restart/

Retrieve operation of resource: graceful-restart

200 OK
graceful-restart_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}

DISCOVERY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/

Update operation of resource: discovery

discovery_schema

discoverybody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/

Create operation of resource: discovery

discovery_schema

discoverybody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/

Delete operation of resource: discovery

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISCOVERY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/

Retrieve operation of resource: discovery

200 OK
discovery_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

LINK-HELLO - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/link-hello/

Update operation of resource: link-hello

link-hello_schema

link-hellobody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "string",
  "interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-HELLO - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/link-hello/

Create operation of resource: link-hello

link-hello_schema

link-hellobody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "string",
  "interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-HELLO - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/link-hello/

Delete operation of resource: link-hello

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LINK-HELLO - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/link-hello/

Retrieve operation of resource: link-hello

200 OK
link-hello_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "hold-time": "string",
  "interval": "string"
}

TARGETED-HELLO - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/targeted-hello/

Update operation of resource: targeted-hello

targeted-hello_schema

targeted-hellobody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "string",
  "interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETED-HELLO - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/targeted-hello/

Create operation of resource: targeted-hello

targeted-hello_schema

targeted-hellobody object

Request Content-Types: application/json
Request Example
{
  "hold-time": "string",
  "interval": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETED-HELLO - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/targeted-hello/

Delete operation of resource: targeted-hello

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETED-HELLO - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/discovery/targeted-hello/

Retrieve operation of resource: targeted-hello

200 OK
targeted-hello_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "hold-time": "string",
  "interval": "string"
}

MLDP - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/

Update operation of resource: mldp

mldp_schema

mldpbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "notifications": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "enable": [ null ]
          },
          "af-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/

Create operation of resource: mldp

mldp_schema

mldpbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "notifications": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "enable": [ null ]
          },
          "af-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/

Delete operation of resource: mldp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/

Retrieve operation of resource: mldp

200 OK
mldp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "enable": [ null ]
              },
              "af-name": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                : { 
PUT                  POST                 DELETE                GET                
                
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      "notifications": [ null ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "enable": [ null ]
          },
          "af-name": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          },
          : { 
PUT            POST           DELETE          GET          
          
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}

VRFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/

Retrieve operation of resource: vrfs

200 OK
vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "enable": [ null ]
            },
            "af-name": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK
vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}

AFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/

Update operation of resource: afs

afs_schema

afsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/

Create operation of resource: afs

afs_schema

afsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/

Delete operation of resource: afs

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/

Retrieve operation of resource: afs

vrf-name: string
in path

ID of vrf-name

200 OK
afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Update operation of resource: af

af_schema

afbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Create operation of resource: af

af_schema

afbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Delete operation of resource: af

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/

Retrieve operation of resource: af

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}

RECURSIVE-FORWARDING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/recursive-forwarding/

Update operation of resource: recursive-forwarding

recursive-forwarding_schema

recursive-forwardingbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECURSIVE-FORWARDING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/recursive-forwarding/

Create operation of resource: recursive-forwarding

recursive-forwarding_schema

recursive-forwardingbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECURSIVE-FORWARDING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/recursive-forwarding/

Delete operation of resource: recursive-forwarding

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECURSIVE-FORWARDING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/recursive-forwarding/

Retrieve operation of resource: recursive-forwarding

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
recursive-forwarding_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  "enable": [ null ]
}

MLDP-RECURSIVE-FEC - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mldp-recursive-fec/

Update operation of resource: mldp-recursive-fec

mldp-recursive-fec_schema

mldp-recursive-fecbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-RECURSIVE-FEC - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mldp-recursive-fec/

Create operation of resource: mldp-recursive-fec

mldp-recursive-fec_schema

mldp-recursive-fecbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-RECURSIVE-FEC - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mldp-recursive-fec/

Delete operation of resource: mldp-recursive-fec

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-RECURSIVE-FEC - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mldp-recursive-fec/

Retrieve operation of resource: mldp-recursive-fec

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
mldp-recursive-fec_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  "enable": [ null ]
}

NEIGHBOR-POLICIES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/

Update operation of resource: neighbor-policies

neighbor-policies_schema

neighbor-policiesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICIES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/

Create operation of resource: neighbor-policies

neighbor-policies_schema

neighbor-policiesbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICIES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/

Delete operation of resource: neighbor-policies

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICIES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/

Retrieve operation of resource: neighbor-policies

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
neighbor-policies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}

NEIGHBOR-POLICY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Update operation of resource: neighbor-policy

neighbor-policy_schema

neighbor-policybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

Request Content-Types: application/json
Request Example
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Create operation of resource: neighbor-policy

neighbor-policy_schema

neighbor-policybody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

Request Content-Types: application/json
Request Example
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Delete operation of resource: neighbor-policy

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Retrieve operation of resource: neighbor-policy

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

200 OK
neighbor-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}

MO-FRR - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mo-frr/

Update operation of resource: mo-frr

mo-frr_schema

mo-frrbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MO-FRR - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mo-frr/

Create operation of resource: mo-frr

mo-frr_schema

mo-frrbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MO-FRR - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mo-frr/

Delete operation of resource: mo-frr

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MO-FRR - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/mo-frr/

Retrieve operation of resource: mo-frr

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
mo-frr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  "enable": [ null ]
}

MAKE-BEFORE-BREAK - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/

Update operation of resource: make-before-break

make-before-break_schema

make-before-breakbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAKE-BEFORE-BREAK - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/

Create operation of resource: make-before-break

make-before-break_schema

make-before-breakbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAKE-BEFORE-BREAK - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/

Delete operation of resource: make-before-break

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAKE-BEFORE-BREAK - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/

Retrieve operation of resource: make-before-break

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
make-before-break_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}

SIGNALING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/signaling/

Update operation of resource: signaling

signaling_schema

signalingbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/signaling/

Create operation of resource: signaling

signaling_schema

signalingbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/signaling/

Delete operation of resource: signaling

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/make-before-break/signaling/

Retrieve operation of resource: signaling

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
signaling_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}

CSC - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/csc/

Update operation of resource: csc

csc_schema

cscbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CSC - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/csc/

Create operation of resource: csc

csc_schema

cscbody object

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CSC - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/csc/

Delete operation of resource: csc

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CSC - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/vrfs/vrf/{vrf-name}/afs/af/{af-name}/csc/

Retrieve operation of resource: csc

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK
csc_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ]
}

DEFAULT-VRF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/

Update operation of resource: default-vrf

AF-TABLE

default-vrfbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/

Create operation of resource: default-vrf

AF-TABLE

default-vrfbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/

Delete operation of resource: default-vrf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-VRF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/

Retrieve operation of resource: default-vrf

200 OK
AF-TABLE

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "enable": [ null ]
        },
        "af-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          : { 
PUT            POST           DELETE          GET          
          
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}

AFS - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/

Update operation of resource: afs

afs_schema

afsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/

Create operation of resource: afs

afs_schema

afsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/

Delete operation of resource: afs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AFS - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/

Retrieve operation of resource: afs

200 OK
afs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "enable": [ null ]
      },
      "af-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

AF - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/

Update operation of resource: af

af_schema

afbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/

Create operation of resource: af

af_schema

afbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/

Delete operation of resource: af

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AF - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/

Retrieve operation of resource: af

af-name: string
in path

ID of af-name

200 OK
af_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  "af-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    : { 
PUT      POST     DELETE    GET    
    
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "policy": "string",
    "enable": [ null ]
  }
}

RECURSIVE-FORWARDING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/recursive-forwarding/

Update operation of resource: recursive-forwarding

recursive-forwarding_schema

recursive-forwardingbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECURSIVE-FORWARDING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/recursive-forwarding/

Create operation of resource: recursive-forwarding

recursive-forwarding_schema

recursive-forwardingbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECURSIVE-FORWARDING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/recursive-forwarding/

Delete operation of resource: recursive-forwarding

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RECURSIVE-FORWARDING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/recursive-forwarding/

Retrieve operation of resource: recursive-forwarding

af-name: string
in path

ID of af-name

200 OK
recursive-forwarding_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  "enable": [ null ]
}

MLDP-RECURSIVE-FEC - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mldp-recursive-fec/

Update operation of resource: mldp-recursive-fec

mldp-recursive-fec_schema

mldp-recursive-fecbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-RECURSIVE-FEC - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mldp-recursive-fec/

Create operation of resource: mldp-recursive-fec

mldp-recursive-fec_schema

mldp-recursive-fecbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-RECURSIVE-FEC - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mldp-recursive-fec/

Delete operation of resource: mldp-recursive-fec

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-RECURSIVE-FEC - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mldp-recursive-fec/

Retrieve operation of resource: mldp-recursive-fec

af-name: string
in path

ID of af-name

200 OK
mldp-recursive-fec_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  "enable": [ null ]
}

NEIGHBOR-POLICIES - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/

Update operation of resource: neighbor-policies

neighbor-policies_schema

neighbor-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICIES - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/

Create operation of resource: neighbor-policies

neighbor-policies_schema

neighbor-policiesbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICIES - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/

Delete operation of resource: neighbor-policies

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICIES - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/

Retrieve operation of resource: neighbor-policies

af-name: string
in path

ID of af-name

200 OK
neighbor-policies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}

NEIGHBOR-POLICY - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Update operation of resource: neighbor-policy

neighbor-policy_schema

neighbor-policybody object

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

Request Content-Types: application/json
Request Example
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICY - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Create operation of resource: neighbor-policy

neighbor-policy_schema

neighbor-policybody object

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

Request Content-Types: application/json
Request Example
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICY - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Delete operation of resource: neighbor-policy

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NEIGHBOR-POLICY - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/neighbor-policies/neighbor-policy/{root-address policy-mode}/

Retrieve operation of resource: neighbor-policy

af-name: string
in path

ID of af-name

root-address policy-mode: string
in path

ID of root-address policy-mode

200 OK
neighbor-policy_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}

MO-FRR - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mo-frr/

Update operation of resource: mo-frr

mo-frr_schema

mo-frrbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MO-FRR - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mo-frr/

Create operation of resource: mo-frr

mo-frr_schema

mo-frrbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MO-FRR - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mo-frr/

Delete operation of resource: mo-frr

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MO-FRR - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/mo-frr/

Retrieve operation of resource: mo-frr

af-name: string
in path

ID of af-name

200 OK
mo-frr_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  "enable": [ null ]
}

MAKE-BEFORE-BREAK - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/

Update operation of resource: make-before-break

make-before-break_schema

make-before-breakbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAKE-BEFORE-BREAK - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/

Create operation of resource: make-before-break

make-before-break_schema

make-before-breakbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "policy": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAKE-BEFORE-BREAK - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/

Delete operation of resource: make-before-break

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAKE-BEFORE-BREAK - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/

Retrieve operation of resource: make-before-break

af-name: string
in path

ID of af-name

200 OK
make-before-break_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "policy": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}

SIGNALING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/signaling/

Update operation of resource: signaling

signaling_schema

signalingbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/signaling/

Create operation of resource: signaling

signaling_schema

signalingbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/signaling/

Delete operation of resource: signaling

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SIGNALING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/make-before-break/signaling/

Retrieve operation of resource: signaling

af-name: string
in path

ID of af-name

200 OK
signaling_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}

CSC - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/csc/

Update operation of resource: csc

csc_schema

cscbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CSC - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/csc/

Create operation of resource: csc

csc_schema

cscbody object

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CSC - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/csc/

Delete operation of resource: csc

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CSC - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/default-vrf/afs/af/{af-name}/csc/

Retrieve operation of resource: csc

af-name: string
in path

ID of af-name

200 OK
csc_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ]
}

MLDP-GLOBAL - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/

Update operation of resource: mldp-global

mldp-global_schema

mldp-globalbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "notifications": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-GLOBAL - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/

Create operation of resource: mldp-global

mldp-global_schema

mldp-globalbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "notifications": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-GLOBAL - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/

Delete operation of resource: mldp-global

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLDP-GLOBAL - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/

Retrieve operation of resource: mldp-global

200 OK
mldp-global_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "notifications": [ null ]
  }
}

LOGGING - Update

PUT Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/logging/

Update operation of resource: logging

logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  "notifications": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/logging/

Create operation of resource: logging

logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  "notifications": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-mpls-ldp-cfg:mpls-ldp/global/mldp/mldp-global/logging/

Retrieve operation of resource: logging

200 OK
logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "notifications": [ null ]
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

200 OK
a1_encrypted-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

200 OK
a1_views_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK
a1_view_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

200 OK
a1_logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

200 OK
a1_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

200 OK
a1_administration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

200 OK
a1_default-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK
a1_default-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

200 OK
a1_encrypted-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

200 OK
a1_agent_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

200 OK
a1_engine-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

200 OK
a1_remotes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK
a1_remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

200 OK
a1_trap_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

200 OK
a1_drop-packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "unknown-user": [ null ]
}

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

200 OK
a1_ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

200 OK
a1_ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

200 OK
a1_system_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

200 OK
a1_targets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK
a1_vrf-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK
a1_vrf-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string"
}

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK
a1_target-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ip-address": "string"
}

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "session-up": [ null ],
    "session-down": [ null ],
    "init-session-threshold-exceeded": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "session-up": [ null ],
    "session-down": [ null ],
    "init-session-threshold-exceeded": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

200 OK
a1_notification_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "session-up": [ null ],
    "session-down": [ null ],
    "init-session-threshold-exceeded": [ null ]
  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

MPLS-LDP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/mpls-ldp/

Update operation of resource: mpls-ldp

a1_mpls-ldp_schema

mpls-ldpbody object

Request Content-Types: application/json
Request Example
{
  "session-up": [ null ],
  "session-down": [ null ],
  "init-session-threshold-exceeded": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LDP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/mpls-ldp/

Create operation of resource: mpls-ldp

a1_mpls-ldp_schema

mpls-ldpbody object

Request Content-Types: application/json
Request Example
{
  "session-up": [ null ],
  "session-down": [ null ],
  "init-session-threshold-exceeded": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LDP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/mpls-ldp/

Delete operation of resource: mpls-ldp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LDP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/mpls-ldp/

Retrieve operation of resource: mpls-ldp

200 OK
a1_mpls-ldp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "session-up": [ null ],
  "session-down": [ null ],
  "init-session-threshold-exceeded": [ null ]
}

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

200 OK
a1_correlator_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

200 OK
a1_rules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

name: string
in path

ID of name

200 OK
a1_rule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

name: string
in path

ID of name

200 OK
a1_root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "index": "string",
  "value": "string"
}

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

name: string
in path

ID of name

200 OK
a1_non-root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_non-root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "index": "string",
  "value": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "ip-address": "string"
}

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

200 OK
a1_rule-sets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

name: string
in path

ID of name

200 OK
a1_rule-set_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

name: string
in path

ID of name

200 OK
a1_rulenames_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK
a1_rulename_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "rulename": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "ip-address": "string"
}

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

200 OK
a1_bulk-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

200 OK
a1_schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK
a1_schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK
a1_instance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string"
}

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

200 OK
a1_transfers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer-schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK
a1_transfer-schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "schema-name": "string"
}

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

200 OK
a1_default-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK
a1_default-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

200 OK
a1_overload-control_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

200 OK
a1_timeouts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

200 OK
a1_users_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string
in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string
in path

ID of user-name

200 OK
a1_user_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

200 OK
a1_vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

name: string
in path

ID of name

200 OK
a1_vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

name: string
in path

ID of name

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

name: string
in path

ID of name

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

name: string
in path

ID of name

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

200 OK
a1_groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

name: string
in path

ID of name

200 OK
a1_group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK
a1_mib_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)

Schema Definitions

ENABLE:

Common node of mldp, vrf

enable: null

Enable Multicast Label Distribution Protocol (mLDP)

Example
{
  "enable": [ null ]
}

AF-TABLE:

Common node of default-vrf, vrf

afs: object

Address Family specific operational data

af: object[]

Operational data for given Address Family

object
mldp-rib-unicast-always: null

Enable MPLS MLDP RIB unicast-always configuration

enable: null

Enable Multicast Label Distribution Protocol (mLDP) under AF.

neighbor-policies: object

MLDP neighbor policies

neighbor-policy: object[]

Route Policy

object
route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

recursive-forwarding: object

Enable recursive forwarding

policy: string

Recursive forwarding policy name

enable: null

Enable recursive forwarding

csc: object

MPLS mLDP CSC

enable: null

Enable MPLS mLDP CSC

af-name: string ipv4, ipv6

Address Family name

make-before-break: object

MPLS mLDP Make-Before-Break configuration

policy: string

Route policy name

signaling: object

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
mldp-recursive-fec: object

MPLS mLDP Recursive FEC

policy: string

Route policy name

enable: null

Enable MPLS mLDP Recursive FEC

mo-frr: object

MPLS mLDP MoFRR

policy: string

Route policy name

enable: null

Enable MPLS mLDP MoFRR

Example
{
  "afs": {
    "af": [
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        "neighbor-policies": {
          "neighbor-policy": [
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        "recursive-forwarding": {
          "policy": "string",
          "enable": [ null ]
        },
        "csc": {
          "enable": [ null ]
        },
        "af-name": "string",
        "make-before-break": {
          "policy": "string",
          "signaling": {
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        "mldp-recursive-fec": {
          "policy": "string",
          "enable": [ null ]
        },
        "mo-frr": {
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}

mpls-ldp_schema:

MPLS LDP configuration

enable: null

Enable Label Distribution Protocol (LDP) globally.Without creating this object the LDP feature will not be enabled. Deleting this object will stop the LDP feature.

global: object

Global configuration for MPLS LDP

entropy-label: object

Configure for LDP Entropy-Label

enable: null

none

igp: object

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
mldp:

MPLS mLDP configuration

discovery: object

Configure Discovery parameters

targeted-hello: object

LDP Targeted Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Targeted Hello interval

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Link Hello interval

disable-instance-tlv: null

Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages

ltrace-buf-multiplier: integer

Configure Ltrace Buffer Multiplier

range:"1..5" default:"1"
session: object

LDP Session parameters

hold-time: integer

LDP Session holdtime

range:"15..65535" units:"second" default:"180"
backoff-time: object

Configure Session Backoff parameters

max-backoff-time: integer

Maximum session backoff time (seconds)

range:"5..2147483" units:"second" default:"120"
initial-backoff-time: integer

Initial session backoff time (seconds)

range:"5..2147483" units:"second" default:"15"
disable-implicit-ipv4: null

Disable the implicit enabling for IPv4 address family

signalling: object

Configure LDP signalling parameters

dscp: string

DSCP for control packets

enable-logging: object

Enable logging of events

nsr: null

Enable logging of NSR events

adjacency: null

Enable logging of adjacency events

session-protection: null

Enable logging of session protection events

neighbor-changes: null

Enable logging of neighbor events

gr-session-changes: null

Enable logging of Graceful Restart (GR) events

nsr: object

Configure LDP Non-Stop Routing

enable: null

none

graceful-restart: object

Configuration for LDP Graceful Restart parameters

reconnect-timeout: integer

Configure Graceful Restart Reconnect Timeout value

range:"60..1800" units:"second" default:"120"
enable: null

none

forwarding-hold-time: integer

Configure Graceful Restart Session holdtime

range:"60..1800" units:"second" default:"180"
default-vrf: object

Global VRF attribute configuration for MPLS LDP

interfaces: object

MPLS LDP configuration pertaining to interfaces

interface: object[]

MPLS LDP configuration for a particular interface

object
global: object

Per VRF interface Global configuration for MPLS LDP

igp: object

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-session-up: object

Interface sync up delay after session up

disable: null

Disable delay after session up

timeout: integer

Time (seconds)

range:"1..600000" units:"second"
discovery: object

Configure interface discovery parameters

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

dual-stack: string ipv4, ipv6

Dual Stack Address Family Preference

interval: string

Link Hello interval

hold-time: string

Time (seconds) - 65535 implies infinite

enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

mldp: object

Interface configuration parameters for mLDP

disable: null

Disable mLDP on LDP enabled interface

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

igp: object

LDP interface IGP configuration

disable-auto-config: null

Disable IGP Auto-config on this interface

global: object

Default VRF Global configuration for MPLS LDP

session: object

LDP Session parameters

downstream-on-demand: object

ACL with the list of neighbors configured for Downstream on Demand

peer-acl-name: string

Name of peer ACL

type: string peer-acl

Downstream on demand type

protection: object

Configure Session Protection parameters

peer-acl-name: string

Name of peer ACL

protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever

Session protection type

duration: integer

Holdup duration

range:"30..2147483"
router-id: string

Configuration for LDP Router ID (LDP ID)

neighbor: object

Configuration related to Neighbors

password: string

Default password for all neigbors

dual-stack: object

Configuration related to neighbor transport

tlv-compliance: null

Configuration to enable neighbor dual-stack tlv-compliance

transport-connection: object

Configuration related to neighbor transport

max-wait: integer

Configuration related to neighbor dual-stack xport-connection max-wait

range:"0..60" units:"second"
prefer: object

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

ldp-ids: object

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

graceful-restart: object

Configuration for per-VRF LDP Graceful Restart parameters

helper-peer: object

Configure parameters related to GR peer(s) opearating in helper mode

maintain-on-local-reset: string

Maintain the state of a GR peer upon a local reset

afs: object

Address Family specific configuration for MPLS LDP

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family type

enable: null

Enable Address Family

neighbor: object

Configuration related to Neighbors

addresses: object

Configuration related to neighbors using neighbor address

address: object[]

IP address based configuration related to a neighbor

object
targeted: null

Establish targeted session with given address

ip-address: string

The IP address

traffic-engineering: object

MPLS Traffic Engingeering parameters for LDP

auto-tunnel-mesh: object

MPLS Traffic Engineering auto-tunnel mesh parameters for LDP

group-all: null

Enable all MPLS TE auto-tunnel mesh-group interfaces

group-ids: object

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

discovery: object

Configure Discovery parameters

transport-address: string

Global discovery transport address for address family

targeted-hello-accept: object

Configure acceptance from and responding to targeted hellos.

peer-acl-name: string

Name of peer ACL

accept-type: string all, from

Type of acceptance

redistribution-protocol: object

MPLS LDP configuration for protocol redistribution

bgp: object

MPLS LDP configuration for protocol redistribution

as: object

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
advertise-to: object

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

label: object

Configure Label policies and control

local: object

Configure local label policies and control

advertise: object

Configure outbound label advertisement

prefix-advertise-policies: object

Configure prefix centric outbound label advertisement using ACL

prefix-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
peer-acl-name: string

Name of peer ACL

prefix-acl-name: string

Name of prefix ACL

advertise-type: string for, for-to

Label advertise type

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: string

LSR ID of neighbor

prefix-acl-name: string

Name of prefix ACL

label-space-id: integer

Label space ID of neighbor

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

remote: object

Configure remote/peer label policies and control

accept: object

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptance of labels from a neighbor for prefix(es) using ACL

object
lsr-id: string

LSR ID of neighbor

prefix-acl-name: string

Name of prefix ACL

label-space-id: integer

Label space ID of neighbor

vrfs: object

VRF Table attribute configuration for MPLS LDP

vrf: object[]

VRF attribute configuration for MPLS LDP

object
interfaces: object

MPLS LDP configuration pertaining to interfaces

interface: object[]

MPLS LDP configuration for a particular interface

object
enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP vrf intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

global: object

Per VRF Global configuration for MPLS LDP

session: object

LDP Session parameters

downstream-on-demand: object

ACL with the list of neighbors configured for Downstream on Demand

peer-acl-name: string

Name of peer ACL

type: string peer-acl

Downstream on demand type

router-id: string

Configuration for LDP Router ID (LDP ID)

neighbor: object

Configuration related to Neighbors

password: string

Default password for all neigbors

ldp-ids: object

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

graceful-restart: object

Configuration for per-VRF LDP Graceful Restart parameters

helper-peer: object

Configure parameters related to GR peer(s) opearating in helper mode

maintain-on-local-reset: string

Maintain the state of a GR peer upon a local reset

vrf-name: string

VRF Name

enable: null

Enable VRF

afs: object

Address Family specific configuration for MPLS LDP vrf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

discovery: object

Configure Discovery parameters

transport-address: string

Global discovery transport address for address family

label: object

Configure Label policies and control

local: object

Configure local label policies and control

advertise: object

Configure outbound label advertisement

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

remote: object

Configure remote/peer label policies and control

accept: object

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "enable": [ null ],
  "global": {
    "entropy-label": {
      "enable": [ null ]
    },
    "igp": {
      "sync": {
        "delay": {
          "on-proc-restart": "integer",
          "on-session-up": "integer"
        }
      }
    },
    "mldp": {
      "vrfs": {
        "vrf": [
          {
            "vrf-name": "string",
            "afs": {
              "af": [
                {
                  "mldp-rib-unicast-always": [ null ],
                  "enable": [ null ],
                  "neighbor-policies": {
                    "neighbor-policy": [
                      {
                        "route-policy": "string",
                        "root-address": "string",
                        "policy-mode": "string"
                      }
                    ]
                  },
                  "recursive-forwarding": {
                    "policy": "string",
                    "enable": [ null ]
                  },
                  "csc": {
                    "enable": [ null ]
                  },
                  "af-name": "string",
                  "make-before-break": {
                    "policy": "string",
                    "signaling": {
                      "forward-delay": "integer",
                      "delete-delay": "integer"
                    }
                  },
                  "mldp-recursive-fec": {
                    "policy": "string",
                    "enable": [ null ]
                  },
                  "mo-frr": {
                    "policy": "string",
                    "enable": [ null ]
                  }
                }
              ]
            }
          }
        ]
      },
      "mldp-global": {
        "logging": {
          "notifications": [ null ]
        }
      },
      "default-vrf": {
        "afs": {
          "af": [
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              "neighbor-policies": {
                "neighbor-policy": [
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              "recursive-forwarding": {
                "policy": "string",
                "enable": [ null ]
              },
              "csc": {
                "enable": [ null ]
              },
              "af-name": "string",
              "make-before-break": {
                "policy": "string",
                "signaling": {
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              "mldp-recursive-fec": {
                "policy": "string",
                "enable": [ null ]
              },
              "mo-frr": {
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      },
      "enable": [ null ]
    },
    "discovery": {
      "targeted-hello": {
        "hold-time": "string",
        "interval": "string"
      },
      "disable-quick-start": [ null ],
      "link-hello": {
        "hold-time": "string",
        "interval": "string"
      },
      "disable-instance-tlv": [ null ]
    },
    "ltrace-buf-multiplier": "integer",
    "session": {
      "hold-time": "integer",
      "backoff-time": {
        "max-backoff-time": "integer",
        "initial-backoff-time": "integer"
      }
    },
    "disable-implicit-ipv4": [ null ],
    "signalling": {}
  }
}

default-vrf_schema:

Global VRF attribute configuration for MPLS LDP

interfaces: object

MPLS LDP configuration pertaining to interfaces

interface: object[]

MPLS LDP configuration for a particular interface

object
global: object

Per VRF interface Global configuration for MPLS LDP

igp: object

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-session-up: object

Interface sync up delay after session up

disable: null

Disable delay after session up

timeout: integer

Time (seconds)

range:"1..600000" units:"second"
discovery: object

Configure interface discovery parameters

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

dual-stack: string ipv4, ipv6

Dual Stack Address Family Preference

interval: string

Link Hello interval

hold-time: string

Time (seconds) - 65535 implies infinite

enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

mldp: object

Interface configuration parameters for mLDP

disable: null

Disable mLDP on LDP enabled interface

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

igp: object

LDP interface IGP configuration

disable-auto-config: null

Disable IGP Auto-config on this interface

global: object

Default VRF Global configuration for MPLS LDP

session: object

LDP Session parameters

downstream-on-demand: object

ACL with the list of neighbors configured for Downstream on Demand

peer-acl-name: string

Name of peer ACL

type: string peer-acl

Downstream on demand type

protection: object

Configure Session Protection parameters

peer-acl-name: string

Name of peer ACL

protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever

Session protection type

duration: integer

Holdup duration

range:"30..2147483"
router-id: string

Configuration for LDP Router ID (LDP ID)

neighbor: object

Configuration related to Neighbors

password: string

Default password for all neigbors

dual-stack: object

Configuration related to neighbor transport

tlv-compliance: null

Configuration to enable neighbor dual-stack tlv-compliance

transport-connection: object

Configuration related to neighbor transport

max-wait: integer

Configuration related to neighbor dual-stack xport-connection max-wait

range:"0..60" units:"second"
prefer: object

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

ldp-ids: object

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

graceful-restart: object

Configuration for per-VRF LDP Graceful Restart parameters

helper-peer: object

Configure parameters related to GR peer(s) opearating in helper mode

maintain-on-local-reset: string

Maintain the state of a GR peer upon a local reset

afs: object

Address Family specific configuration for MPLS LDP

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family type

enable: null

Enable Address Family

neighbor: object

Configuration related to Neighbors

addresses: object

Configuration related to neighbors using neighbor address

address: object[]

IP address based configuration related to a neighbor

object
targeted: null

Establish targeted session with given address

ip-address: string

The IP address

traffic-engineering: object

MPLS Traffic Engingeering parameters for LDP

auto-tunnel-mesh: object

MPLS Traffic Engineering auto-tunnel mesh parameters for LDP

group-all: null

Enable all MPLS TE auto-tunnel mesh-group interfaces

group-ids: object

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

discovery: object

Configure Discovery parameters

transport-address: string

Global discovery transport address for address family

targeted-hello-accept: object

Configure acceptance from and responding to targeted hellos.

peer-acl-name: string

Name of peer ACL

accept-type: string all, from

Type of acceptance

redistribution-protocol: object

MPLS LDP configuration for protocol redistribution

bgp: object

MPLS LDP configuration for protocol redistribution

as: object

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
advertise-to: object

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

label: object

Configure Label policies and control

local: object

Configure local label policies and control

advertise: object

Configure outbound label advertisement

prefix-advertise-policies: object

Configure prefix centric outbound label advertisement using ACL

prefix-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
peer-acl-name: string

Name of peer ACL

prefix-acl-name: string

Name of prefix ACL

advertise-type: string for, for-to

Label advertise type

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: string

LSR ID of neighbor

prefix-acl-name: string

Name of prefix ACL

label-space-id: integer

Label space ID of neighbor

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

remote: object

Configure remote/peer label policies and control

accept: object

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptance of labels from a neighbor for prefix(es) using ACL

object
lsr-id: string

LSR ID of neighbor

prefix-acl-name: string

Name of prefix ACL

label-space-id: integer

Label space ID of neighbor

Example
{
  "interfaces": {
    "interface": [
      {
        "global": {
          "igp": {
            "sync": {
              "delay": {
                "on-session-up": {
                  "disable": [ null ],
                  "timeout": "integer"
                }
              }
            }
          },
          "discovery": {
            "disable-quick-start": [ null ],
            "link-hello": {
              "dual-stack": "string",
              "interval": "string",
              "hold-time": "string"
            }
          }
        },
        "enable": [ null ],
        "interface-name": "string",
        "afs": {
          "af": [
            {
              "af-name": "string",
              "enable": [ null ],
              "mldp": {
                "disable": [ null ]
              },
              "discovery": {
                "transport-address": {
                  "address-type": "string",
                  "address": "string"
                }
              },
              "igp": {
                "disable-auto-config": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  "global": {
    "session": {
      "downstream-on-demand": {
        "peer-acl-name": "string",
        "type": "string"
      },
      "protection": {
        "peer-acl-name": "string",
        "protection-type": "string",
        "duration": "integer"
      }
    },
    "router-id": "string",
    "neighbor": {
      "password": "string",
      "dual-stack": {
        "tlv-compliance": [ null ],
        "transport-connection": {
          "max-wait": "integer",
          "prefer": {
            "ipv4": [ null ]
          }
        }
      },
      "ldp-ids": {
        "ldp-id": [
          {
            "lsr-id": "string",
            "password": {
              "command-type": "string",
              "password": "string"
            },
            "label-space-id": "integer"
          }
        ]
      }
    },
    "graceful-restart": {
      "helper-peer": {
        "maintain-on-local-reset": "string"
      }
    }
  },
  "afs": {
    "af": [
      {
        "af-name": "string",
        "enable": [ null ],
        "neighbor": {
          "addresses": {
            "address": [
              {
                "targeted": [ null ],
                "ip-address": "string"
              }
            ]
          }
        },
        "traffic-engineering": {
          "auto-tunnel-mesh": {
            "group-all": [ null ],
            "group-ids": {
              "group-id": [
                {
                  "mesh-group-id": "string"
                }
              ]
            }
          }
        },
        "discovery": {
          "transport-address": "string",
          "targeted-hello-accept": {
            "peer-acl-name": "string",
            "accept-type": "string"
          }
        },
        "redistribution-protocol": {
          "bgp": {
            "as": {
              "as-xx": "integer",
              "as-yy": "integer"
            },
            "advertise-to": {
              "peer-acl-name": "string",
              "type": "string"
            }
          }
        },
        "label": {
          "local": {
            "advertise": {
              "prefix-advertise-policies": {
                "prefix-advertise-policy": [
                  {
                    "peer-acl-name": "string",
                    "prefix-acl-name": "string"
                  }
                ]
              }
            }
          }
        }
      }
    ]
  }
}

afs_schema:

Address Family specific operational data

af: object[]

Operational data for given Address Family

object
mldp-rib-unicast-always: null

Enable MPLS MLDP RIB unicast-always configuration

enable: null

Enable Multicast Label Distribution Protocol (mLDP) under AF.

neighbor-policies: object

MLDP neighbor policies

neighbor-policy: object[]

Route Policy

object
route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

recursive-forwarding: object

Enable recursive forwarding

policy: string

Recursive forwarding policy name

enable: null

Enable recursive forwarding

csc: object

MPLS mLDP CSC

enable: null

Enable MPLS mLDP CSC

af-name: string ipv4, ipv6

Address Family name

make-before-break: object

MPLS mLDP Make-Before-Break configuration

policy: string

Route policy name

signaling: object

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
mldp-recursive-fec: object

MPLS mLDP Recursive FEC

policy: string

Route policy name

enable: null

Enable MPLS mLDP Recursive FEC

mo-frr: object

MPLS mLDP MoFRR

policy: string

Route policy name

enable: null

Enable MPLS mLDP MoFRR

Example
{
  "af": [
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      "neighbor-policies": {
        "neighbor-policy": [
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      "recursive-forwarding": {
        "policy": "string",
        "enable": [ null ]
      },
      "csc": {
        "enable": [ null ]
      },
      "af-name": "string",
      "make-before-break": {
        "policy": "string",
        "signaling": {
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      "mldp-recursive-fec": {
        "policy": "string",
        "enable": [ null ]
      },
      "mo-frr": {
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

af_schema:

mldp-rib-unicast-always: null

Enable MPLS MLDP RIB unicast-always configuration

enable: null

Enable Multicast Label Distribution Protocol (mLDP) under AF.

neighbor-policies: object

MLDP neighbor policies

neighbor-policy: object[]

Route Policy

object
route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

recursive-forwarding: object

Enable recursive forwarding

policy: string

Recursive forwarding policy name

enable: null

Enable recursive forwarding

csc: object

MPLS mLDP CSC

enable: null

Enable MPLS mLDP CSC

af-name: string ipv4, ipv6

Address Family name

make-before-break: object

MPLS mLDP Make-Before-Break configuration

policy: string

Route policy name

signaling: object

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
mldp-recursive-fec: object

MPLS mLDP Recursive FEC

policy: string

Route policy name

enable: null

Enable MPLS mLDP Recursive FEC

mo-frr: object

MPLS mLDP MoFRR

policy: string

Route policy name

enable: null

Enable MPLS mLDP MoFRR

Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  "neighbor-policies": {
    "neighbor-policy": [
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  "recursive-forwarding": {
    "policy": "string",
    "enable": [ null ]
  },
  "csc": {
    "enable": [ null ]
  },
  "af-name": "string",
  "make-before-break": {
    "policy": "string",
    "signaling": {
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  "mldp-recursive-fec": {
    "policy": "string",
    "enable": [ null ]
  },
  "mo-frr": {
    "policy": "string",
    "enable": [ null ]
  }
}

label_schema:

Configure Label policies and control

local: object

Configure local label policies and control

advertise: object

Configure outbound label advertisement

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

remote: object

Configure remote/peer label policies and control

accept: object

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "local": {
    "advertise": {
      "interfaces": {
        "interface": [
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      "peer-advertise-policies": {
        "peer-advertise-policy": [
          {
            "lsr-id": [
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      "explicit-null": {
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    "allocate": {
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  "remote": {
    "accept": {
      "peer-accept-policies": {
        "peer-accept-policy": [
          {
            "lsr-id": [
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}

remote_schema:

Configure remote/peer label policies and control

accept: object

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "accept": {
    "peer-accept-policies": {
      "peer-accept-policy": [
        {
          "lsr-id": [
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    }
  }
}

accept_schema:

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "peer-accept-policies": {
    "peer-accept-policy": [
      {
        "lsr-id": [
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}

peer-accept-policies_schema:

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "peer-accept-policy": [
    {
      "lsr-id": [
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

peer-accept-policy_schema:

lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "lsr-id": [
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

local_schema:

Configure local label policies and control

advertise: object

Configure outbound label advertisement

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

Example
{
  "advertise": {
    "interfaces": {
      "interface": [
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    "peer-advertise-policies": {
      "peer-advertise-policy": [
        {
          "lsr-id": [
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    "explicit-null": {
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  "allocate": {
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}

advertise_schema:

Configure outbound label advertisement

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

Example
{
  "interfaces": {
    "interface": [
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  "peer-advertise-policies": {
    "peer-advertise-policy": [
      {
        "lsr-id": [
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  "explicit-null": {
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}

peer-advertise-policies_schema:

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "peer-advertise-policy": [
    {
      "lsr-id": [
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

peer-advertise-policy_schema:

lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "lsr-id": [
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

prefix-advertise-policies_schema:

Configure prefix centric outbound label advertisement using ACL

prefix-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
peer-acl-name: string

Name of peer ACL

prefix-acl-name: string

Name of prefix ACL

advertise-type: string for, for-to

Label advertise type

Example
{
  "prefix-advertise-policy": [
    {
      "peer-acl-name": "string",
      "prefix-acl-name": "string",
      "advertise-type": "string"
    }
  ]
}

prefix-advertise-policy_schema:

peer-acl-name: string

Name of peer ACL

prefix-acl-name: string

Name of prefix ACL

advertise-type: string for, for-to

Label advertise type

Example
{
  "peer-acl-name": "string",
  "prefix-acl-name": "string",
  "advertise-type": "string"
}

explicit-null_schema:

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

Example
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}

interfaces_schema:

MPLS LDP configuration pertaining to interfaces

interface: object[]

MPLS LDP configuration for a particular interface

object
enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP vrf intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

Example
{
  "interface": [
    {
      "enable": [ null ],
      "interface-name": "string",
      "afs": {
        "af": [
          {
            "af-name": "string",
            "enable": [ null ],
            "discovery": {
              "transport-address": {
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}

interface_schema:

enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP vrf intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

Example
{
  "enable": [ null ],
  "interface-name": "string",
  "afs": {
    "af": [
      {
        "af-name": "string",
        "enable": [ null ],
        "discovery": {
          "transport-address": {
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}

allocate_schema:

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

Example
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}

discovery_schema:

Configure Discovery parameters

targeted-hello: object

LDP Targeted Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Targeted Hello interval

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Link Hello interval

disable-instance-tlv: null

Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages

Example
{
  "targeted-hello": {
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  "link-hello": {
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

targeted-hello-accept_schema:

Configure acceptance from and responding to targeted hellos.

peer-acl-name: string

Name of peer ACL

accept-type: string all, from

Type of acceptance

Example
{
  "peer-acl-name": "string",
  "accept-type": "string"
}

traffic-engineering_schema:

MPLS Traffic Engingeering parameters for LDP

auto-tunnel-mesh: object

MPLS Traffic Engineering auto-tunnel mesh parameters for LDP

group-all: null

Enable all MPLS TE auto-tunnel mesh-group interfaces

group-ids: object

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

Example
{
  "auto-tunnel-mesh": {
    "group-all": [ null ],
    "group-ids": {
      "group-id": [
        {
          "mesh-group-id": "string"
        }
      ]
    }
  }
}

auto-tunnel-mesh_schema:

MPLS Traffic Engineering auto-tunnel mesh parameters for LDP

group-all: null

Enable all MPLS TE auto-tunnel mesh-group interfaces

group-ids: object

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

Example
{
  "group-all": [ null ],
  "group-ids": {
    "group-id": [
      {
        "mesh-group-id": "string"
      }
    ]
  }
}

group-ids_schema:

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

Example
{
  "group-id": [
    {
      "mesh-group-id": "string"
    }
  ]
}

group-id_schema:

mesh-group-id: string

Mesh group ID

Example
{
  "mesh-group-id": "string"
}

neighbor_schema:

Configuration related to Neighbors

password: string

Default password for all neigbors

ldp-ids: object

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

Example
{
  "password": "string",
  "ldp-ids": {
    "ldp-id": [
      {
        "lsr-id": "string",
        "password": {
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}

addresses_schema:

Configuration related to neighbors using neighbor address

address: object[]

IP address based configuration related to a neighbor

object
targeted: null

Establish targeted session with given address

ip-address: string

The IP address

Example
{
  "address": [
    {
      "targeted": [ null ],
      "ip-address": "string"
    }
  ]
}

address_schema:

targeted: null

Establish targeted session with given address

ip-address: string

The IP address

Example
{
  "targeted": [ null ],
  "ip-address": "string"
}

redistribution-protocol_schema:

MPLS LDP configuration for protocol redistribution

bgp: object

MPLS LDP configuration for protocol redistribution

as: object

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
advertise-to: object

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

Example
{
  "bgp": {
    "as": {
      "as-xx": "integer",
      "as-yy": "integer"
    },
    "advertise-to": {
      "peer-acl-name": "string",
      "type": "string"
    }
  }
}

bgp_schema:

MPLS LDP configuration for protocol redistribution

as: object

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
advertise-to: object

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

Example
{
  "as": {
    "as-xx": "integer",
    "as-yy": "integer"
  },
  "advertise-to": {
    "peer-acl-name": "string",
    "type": "string"
  }
}

as_schema:

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
Example
{
  "as-xx": "integer",
  "as-yy": "integer"
}

advertise-to_schema:

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

Example
{
  "peer-acl-name": "string",
  "type": "string"
}

global_schema:

Global configuration for MPLS LDP

entropy-label: object

Configure for LDP Entropy-Label

enable: null

none

igp: object

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
mldp:

MPLS mLDP configuration

discovery: object

Configure Discovery parameters

targeted-hello: object

LDP Targeted Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Targeted Hello interval

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Link Hello interval

disable-instance-tlv: null

Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages

ltrace-buf-multiplier: integer

Configure Ltrace Buffer Multiplier

range:"1..5" default:"1"
session: object

LDP Session parameters

hold-time: integer

LDP Session holdtime

range:"15..65535" units:"second" default:"180"
backoff-time: object

Configure Session Backoff parameters

max-backoff-time: integer

Maximum session backoff time (seconds)

range:"5..2147483" units:"second" default:"120"
initial-backoff-time: integer

Initial session backoff time (seconds)

range:"5..2147483" units:"second" default:"15"
disable-implicit-ipv4: null

Disable the implicit enabling for IPv4 address family

signalling: object

Configure LDP signalling parameters

dscp: string

DSCP for control packets

enable-logging: object

Enable logging of events

nsr: null

Enable logging of NSR events

adjacency: null

Enable logging of adjacency events

session-protection: null

Enable logging of session protection events

neighbor-changes: null

Enable logging of neighbor events

gr-session-changes: null

Enable logging of Graceful Restart (GR) events

nsr: object

Configure LDP Non-Stop Routing

enable: null

none

graceful-restart: object

Configuration for LDP Graceful Restart parameters

reconnect-timeout: integer

Configure Graceful Restart Reconnect Timeout value

range:"60..1800" units:"second" default:"120"
enable: null

none

forwarding-hold-time: integer

Configure Graceful Restart Session holdtime

range:"60..1800" units:"second" default:"180"
Example
{
  "entropy-label": {
    "enable": [ null ]
  },
  "igp": {
    "sync": {
      "delay": {
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  "mldp": {
    "vrfs": {
      "vrf": [
        {
          "vrf-name": "string",
          "afs": {
            "af": [
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                "neighbor-policies": {
                  "neighbor-policy": [
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                "recursive-forwarding": {
                  "policy": "string",
                  "enable": [ null ]
                },
                "csc": {
                  "enable": [ null ]
                },
                "af-name": "string",
                "make-before-break": {
                  "policy": "string",
                  "signaling": {
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                "mldp-recursive-fec": {
                  "policy": "string",
                  "enable": [ null ]
                },
                "mo-frr": {
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    "mldp-global": {
      "logging": {
        "notifications": [ null ]
      }
    },
    "default-vrf": {
      "afs": {
        "af": [
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            "neighbor-policies": {
              "neighbor-policy": [
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            "recursive-forwarding": {
              "policy": "string",
              "enable": [ null ]
            },
            "csc": {
              "enable": [ null ]
            },
            "af-name": "string",
            "make-before-break": {
              "policy": "string",
              "signaling": {
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            "mldp-recursive-fec": {
              "policy": "string",
              "enable": [ null ]
            },
            "mo-frr": {
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  "discovery": {
    "targeted-hello": {
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    "link-hello": {
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  "session": {
    "hold-time": "integer",
    "backoff-time": {
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  "signalling": {
    "dscp": "string"
  },
  "enable-logging": {}
}

session_schema:

LDP Session parameters

hold-time: integer

LDP Session holdtime

range:"15..65535" units:"second" default:"180"
backoff-time: object

Configure Session Backoff parameters

max-backoff-time: integer

Maximum session backoff time (seconds)

range:"5..2147483" units:"second" default:"120"
initial-backoff-time: integer

Initial session backoff time (seconds)

range:"5..2147483" units:"second" default:"15"
Example
{
  "hold-time": "integer",
  "backoff-time": {
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}

protection_schema:

Configure Session Protection parameters

peer-acl-name: string

Name of peer ACL

protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever

Session protection type

duration: integer

Holdup duration

range:"30..2147483"
Example
{
  "peer-acl-name": "string",
  "protection-type": "string",
  "duration": "integer"
}

downstream-on-demand_schema:

ACL with the list of neighbors configured for Downstream on Demand

peer-acl-name: string

Name of peer ACL

type: string peer-acl

Downstream on demand type

Example
{
  "peer-acl-name": "string",
  "type": "string"
}

ldp-ids_schema:

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

Example
{
  "ldp-id": [
    {
      "lsr-id": "string",
      "password": {
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}

ldp-id_schema:

lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

Example
{
  "lsr-id": "string",
  "password": {
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}

password_schema:

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

Example
{
  "command-type": "string",
  "password": "string"
}

dual-stack_schema:

Configuration related to neighbor transport

tlv-compliance: null

Configuration to enable neighbor dual-stack tlv-compliance

transport-connection: object

Configuration related to neighbor transport

max-wait: integer

Configuration related to neighbor dual-stack xport-connection max-wait

range:"0..60" units:"second"
prefer: object

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

Example
{
  "tlv-compliance": [ null ],
  "transport-connection": {
    "max-wait": "integer",
    "prefer": {
      "ipv4": [ null ]
    }
  }
}

transport-connection_schema:

Configuration related to neighbor transport

max-wait: integer

Configuration related to neighbor dual-stack xport-connection max-wait

range:"0..60" units:"second"
prefer: object

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

Example
{
  "max-wait": "integer",
  "prefer": {
    "ipv4": [ null ]
  }
}

prefer_schema:

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

Example
{
  "ipv4": [ null ]
}

graceful-restart_schema:

Configuration for LDP Graceful Restart parameters

reconnect-timeout: integer

Configure Graceful Restart Reconnect Timeout value

range:"60..1800" units:"second" default:"120"
enable: null

none

forwarding-hold-time: integer

Configure Graceful Restart Session holdtime

range:"60..1800" units:"second" default:"180"
Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}

helper-peer_schema:

Configure parameters related to GR peer(s) opearating in helper mode

maintain-on-local-reset: string

Maintain the state of a GR peer upon a local reset

Example
{
  "maintain-on-local-reset": "string"
}

transport-address_schema:

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

Example
{
  "address-type": "string",
  "address": "string"
}

igp_schema:

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
Example
{
  "sync": {
    "delay": {
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}

mldp_schema:

MPLS mLDP configuration

vrfs: object

VRF Table attribute configuration for MPLS LDP

vrf: object[]

VRF attribute configuration for MPLS LDP

vrf-name: string

VRF Name

mldp-global: object

Global configuration for mLDP

logging: object

MPLS mLDP logging

notifications: null

MPLS mLDP logging notifications

default-vrf: AF-TABLE

Default VRF attribute configuration for mLDP

Example
{
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string",
        "afs": {
          "af": [
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              "neighbor-policies": {
                "neighbor-policy": [
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              "recursive-forwarding": {
                "policy": "string",
                "enable": [ null ]
              },
              "csc": {
                "enable": [ null ]
              },
              "af-name": "string",
              "make-before-break": {
                "policy": "string",
                "signaling": {
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              "mldp-recursive-fec": {
                "policy": "string",
                "enable": [ null ]
              },
              "mo-frr": {
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  "mldp-global": {
    "logging": {
      "notifications": [ null ]
    }
  },
  "default-vrf": {
    "afs": {
      "af": [
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          "neighbor-policies": {
            "neighbor-policy": [
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          "recursive-forwarding": {
            "policy": "string",
            "enable": [ null ]
          },
          "csc": {
            "enable": [ null ]
          },
          "af-name": "string",
          "make-before-break": {
            "policy": "string",
            "signaling": {
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          "mldp-recursive-fec": {
            "policy": "string",
            "enable": [ null ]
          },
          "mo-frr": {
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}

sync_schema:

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
Example
{
  "delay": {
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}

delay_schema:

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
Example
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}

on-session-up_schema:

Interface sync up delay after session up

disable: null

Disable delay after session up

timeout: integer

Time (seconds)

range:"1..600000" units:"second"
Example
{
  "disable": [ null ],
  "timeout": "integer"
}

vrfs_schema:

VRF Table attribute configuration for MPLS LDP

vrf: object[]

VRF attribute configuration for MPLS LDP

vrf-name: string

VRF Name

Example
{
  "vrf": [
    {
      "vrf-name": "string",
      "afs": {
        "af": [
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            "neighbor-policies": {
              "neighbor-policy": [
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            "recursive-forwarding": {
              "policy": "string",
              "enable": [ null ]
            },
            "csc": {
              "enable": [ null ]
            },
            "af-name": "string",
            "make-before-break": {
              "policy": "string",
              "signaling": {
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            "mldp-recursive-fec": {
              "policy": "string",
              "enable": [ null ]
            },
            "mo-frr": {
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    }
  ]
}

vrf_schema:

vrf-name: string

VRF Name

Example
{
  "vrf-name": "string",
  "afs": {
    "af": [
      {
        "mldp-rib-unicast-always": [ null ],
        "enable": [ null ],
        "neighbor-policies": {
          "neighbor-policy": [
            {
              "route-policy": "string",
              "root-address": "string",
              "policy-mode": "string"
            }
          ]
        },
        "recursive-forwarding": {
          "policy": "string",
          "enable": [ null ]
        },
        "csc": {
          "enable": [ null ]
        },
        "af-name": "string",
        "make-before-break": {
          "policy": "string",
          "signaling": {
            "forward-delay": "integer",
            "delete-delay": "integer"
          }
        },
        "mldp-recursive-fec": {
          "policy": "string",
          "enable": [ null ]
        },
        "mo-frr": {
          "policy": "string",
          "enable": [ null ]
        }
      }
    ]
  }
}

lsr-id_schema:

lsr-id: string

LSR ID of neighbor

Example
{
  "lsr-id": "string"
}

entropy-label_schema:

Configure for LDP Entropy-Label

enable: null

none

Example
{
  "enable": [ null ]
}

backoff-time_schema:

Configure Session Backoff parameters

max-backoff-time: integer

Maximum session backoff time (seconds)

range:"5..2147483" units:"second" default:"120"
initial-backoff-time: integer

Initial session backoff time (seconds)

range:"5..2147483" units:"second" default:"15"
Example
{
  "max-backoff-time": "integer",
  "initial-backoff-time": "integer"
}

enable-logging_schema:

Enable logging of events

nsr: null

Enable logging of NSR events

adjacency: null

Enable logging of adjacency events

session-protection: null

Enable logging of session protection events

neighbor-changes: null

Enable logging of neighbor events

gr-session-changes: null

Enable logging of Graceful Restart (GR) events

Example
{
  "nsr": [ null ],
  "adjacency": [ null ],
  "session-protection": [ null ],
  "neighbor-changes": [ null ],
  "gr-session-changes": [ null ]
}

signalling_schema:

Configure LDP signalling parameters

dscp: string

DSCP for control packets

Example
{
  "dscp": "string"
}

nsr_schema:

Configure LDP Non-Stop Routing

enable: null

none

Example
{
  "enable": [ null ]
}

targeted-hello_schema:

LDP Targeted Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Targeted Hello interval

Example
{
  "hold-time": "string",
  "interval": "string"
}

recursive-forwarding_schema:

Enable recursive forwarding

policy: string

Recursive forwarding policy name

enable: null

Enable recursive forwarding

Example
{
  "policy": "string",
  "enable": [ null ]
}

mldp-recursive-fec_schema:

MPLS mLDP Recursive FEC

policy: string

Route policy name

enable: null

Enable MPLS mLDP Recursive FEC

Example
{
  "policy": "string",
  "enable": [ null ]
}

neighbor-policies_schema:

MLDP neighbor policies

neighbor-policy: object[]

Route Policy

object
route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

Example
{
  "neighbor-policy": [
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}

neighbor-policy_schema:

route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

Example
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}

mo-frr_schema:

MPLS mLDP MoFRR

policy: string

Route policy name

enable: null

Enable MPLS mLDP MoFRR

Example
{
  "policy": "string",
  "enable": [ null ]
}

make-before-break_schema:

MPLS mLDP Make-Before-Break configuration

policy: string

Route policy name

signaling: object

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
Example
{
  "policy": "string",
  "signaling": {
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}

signaling_schema:

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
Example
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}

csc_schema:

MPLS mLDP CSC

enable: null

Enable MPLS mLDP CSC

Example
{
  "enable": [ null ]
}

mldp-global_schema:

Global configuration for mLDP

logging: object

MPLS mLDP logging

notifications: null

MPLS mLDP logging notifications

Example
{
  "logging": {
    "notifications": [ null ]
  }
}

logging_schema:

MPLS mLDP logging

notifications: null

MPLS mLDP logging notifications

Example
{
  "notifications": [ null ]
}

a1_mpls-ldp_schema:

MPLS-LDP-STD-MIB notification configuration

session-up: null

Enable mplsLdpSessionUp notification

session-down: null

Enable mplsLdpSessionDown notification

init-session-threshold-exceeded: null

Enable mplsLdpInitSessionThresholdExceeded notification

Example
{
  "session-up": [ null ],
  "session-down": [ null ],
  "init-session-threshold-exceeded": [ null ]
}

a1_default-vrf_schema:

Global VRF attribute configuration for MPLS LDP

interfaces: object

MPLS LDP configuration pertaining to interfaces

interface: object[]

MPLS LDP configuration for a particular interface

object
global: object

Per VRF interface Global configuration for MPLS LDP

igp: object

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-session-up: object

Interface sync up delay after session up

disable: null

Disable delay after session up

timeout: integer

Time (seconds)

range:"1..600000" units:"second"
discovery: object

Configure interface discovery parameters

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

dual-stack: string ipv4, ipv6

Dual Stack Address Family Preference

interval: string

Link Hello interval

hold-time: string

Time (seconds) - 65535 implies infinite

enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

mldp: object

Interface configuration parameters for mLDP

disable: null

Disable mLDP on LDP enabled interface

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

igp: object

LDP interface IGP configuration

disable-auto-config: null

Disable IGP Auto-config on this interface

global: object

Default VRF Global configuration for MPLS LDP

session: object

LDP Session parameters

downstream-on-demand: object

ACL with the list of neighbors configured for Downstream on Demand

peer-acl-name: string

Name of peer ACL

type: string peer-acl

Downstream on demand type

protection: object

Configure Session Protection parameters

peer-acl-name: string

Name of peer ACL

protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever

Session protection type

duration: integer

Holdup duration

range:"30..2147483"
router-id: string

Configuration for LDP Router ID (LDP ID)

neighbor: object

Configuration related to Neighbors

password: string

Default password for all neigbors

dual-stack: object

Configuration related to neighbor transport

tlv-compliance: null

Configuration to enable neighbor dual-stack tlv-compliance

transport-connection: object

Configuration related to neighbor transport

max-wait: integer

Configuration related to neighbor dual-stack xport-connection max-wait

range:"0..60" units:"second"
prefer: object

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

ldp-ids: object

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

graceful-restart: object

Configuration for per-VRF LDP Graceful Restart parameters

helper-peer: object

Configure parameters related to GR peer(s) opearating in helper mode

maintain-on-local-reset: string

Maintain the state of a GR peer upon a local reset

afs: object

Address Family specific configuration for MPLS LDP

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family type

enable: null

Enable Address Family

neighbor: object

Configuration related to Neighbors

addresses: object

Configuration related to neighbors using neighbor address

address: object[]

IP address based configuration related to a neighbor

object
targeted: null

Establish targeted session with given address

ip-address: string

The IP address

traffic-engineering: object

MPLS Traffic Engingeering parameters for LDP

auto-tunnel-mesh: object

MPLS Traffic Engineering auto-tunnel mesh parameters for LDP

group-all: null

Enable all MPLS TE auto-tunnel mesh-group interfaces

group-ids: object

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

discovery: object

Configure Discovery parameters

transport-address: string

Global discovery transport address for address family

targeted-hello-accept: object

Configure acceptance from and responding to targeted hellos.

peer-acl-name: string

Name of peer ACL

accept-type: string all, from

Type of acceptance

redistribution-protocol: object

MPLS LDP configuration for protocol redistribution

bgp: object

MPLS LDP configuration for protocol redistribution

as: object

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
advertise-to: object

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

label: object

Configure Label policies and control

local: object

Configure local label policies and control

advertise: object

Configure outbound label advertisement

prefix-advertise-policies: object

Configure prefix centric outbound label advertisement using ACL

prefix-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
peer-acl-name: string

Name of peer ACL

prefix-acl-name: string

Name of prefix ACL

advertise-type: string for, for-to

Label advertise type

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: string

LSR ID of neighbor

prefix-acl-name: string

Name of prefix ACL

label-space-id: integer

Label space ID of neighbor

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

remote: object

Configure remote/peer label policies and control

accept: object

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptance of labels from a neighbor for prefix(es) using ACL

object
lsr-id: string

LSR ID of neighbor

prefix-acl-name: string

Name of prefix ACL

label-space-id: integer

Label space ID of neighbor

Example
{
  "interfaces": {
    "interface": [
      {
        "global": {
          "igp": {
            "sync": {
              "delay": {
                "on-session-up": {
                  "disable": [ null ],
                  "timeout": "integer"
                }
              }
            }
          },
          "discovery": {
            "disable-quick-start": [ null ],
            "link-hello": {
              "dual-stack": "string",
              "interval": "string",
              "hold-time": "string"
            }
          }
        },
        "enable": [ null ],
        "interface-name": "string",
        "afs": {
          "af": [
            {
              "af-name": "string",
              "enable": [ null ],
              "mldp": {
                "disable": [ null ]
              },
              "discovery": {
                "transport-address": {
                  "address-type": "string",
                  "address": "string"
                }
              },
              "igp": {
                "disable-auto-config": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  "global": {
    "session": {
      "downstream-on-demand": {
        "peer-acl-name": "string",
        "type": "string"
      },
      "protection": {
        "peer-acl-name": "string",
        "protection-type": "string",
        "duration": "integer"
      }
    },
    "router-id": "string",
    "neighbor": {
      "password": "string",
      "dual-stack": {
        "tlv-compliance": [ null ],
        "transport-connection": {
          "max-wait": "integer",
          "prefer": {
            "ipv4": [ null ]
          }
        }
      },
      "ldp-ids": {
        "ldp-id": [
          {
            "lsr-id": "string",
            "password": {
              "command-type": "string",
              "password": "string"
            },
            "label-space-id": "integer"
          }
        ]
      }
    },
    "graceful-restart": {
      "helper-peer": {
        "maintain-on-local-reset": "string"
      }
    }
  },
  "afs": {
    "af": [
      {
        "af-name": "string",
        "enable": [ null ],
        "neighbor": {
          "addresses": {
            "address": [
              {
                "targeted": [ null ],
                "ip-address": "string"
              }
            ]
          }
        },
        "traffic-engineering": {
          "auto-tunnel-mesh": {
            "group-all": [ null ],
            "group-ids": {
              "group-id": [
                {
                  "mesh-group-id": "string"
                }
              ]
            }
          }
        },
        "discovery": {
          "transport-address": "string",
          "targeted-hello-accept": {
            "peer-acl-name": "string",
            "accept-type": "string"
          }
        },
        "redistribution-protocol": {
          "bgp": {
            "as": {
              "as-xx": "integer",
              "as-yy": "integer"
            },
            "advertise-to": {
              "peer-acl-name": "string",
              "type": "string"
            }
          }
        },
        "label": {
          "local": {
            "advertise": {
              "prefix-advertise-policies": {
                "prefix-advertise-policy": [
                  {
                    "peer-acl-name": "string",
                    "prefix-acl-name": "string"
                  }
                ]
              }
            }
          }
        }
      }
    ]
  }
}

a1_afs_schema:

Address Family specific operational data

af: object[]

Operational data for given Address Family

object
mldp-rib-unicast-always: null

Enable MPLS MLDP RIB unicast-always configuration

enable: null

Enable Multicast Label Distribution Protocol (mLDP) under AF.

neighbor-policies: object

MLDP neighbor policies

neighbor-policy: object[]

Route Policy

object
route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

recursive-forwarding: object

Enable recursive forwarding

policy: string

Recursive forwarding policy name

enable: null

Enable recursive forwarding

csc: object

MPLS mLDP CSC

enable: null

Enable MPLS mLDP CSC

af-name: string ipv4, ipv6

Address Family name

make-before-break: object

MPLS mLDP Make-Before-Break configuration

policy: string

Route policy name

signaling: object

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
mldp-recursive-fec: object

MPLS mLDP Recursive FEC

policy: string

Route policy name

enable: null

Enable MPLS mLDP Recursive FEC

mo-frr: object

MPLS mLDP MoFRR

policy: string

Route policy name

enable: null

Enable MPLS mLDP MoFRR

Example
{
  "af": [
    {
      "mldp-rib-unicast-always": [ null ],
      "enable": [ null ],
      "neighbor-policies": {
        "neighbor-policy": [
          {
            "route-policy": "string",
            "root-address": "string",
            "policy-mode": "string"
          }
        ]
      },
      "recursive-forwarding": {
        "policy": "string",
        "enable": [ null ]
      },
      "csc": {
        "enable": [ null ]
      },
      "af-name": "string",
      "make-before-break": {
        "policy": "string",
        "signaling": {
          "forward-delay": "integer",
          "delete-delay": "integer"
        }
      },
      "mldp-recursive-fec": {
        "policy": "string",
        "enable": [ null ]
      },
      "mo-frr": {
        "policy": "string",
        "enable": [ null ]
      }
    }
  ]
}

a1_af_schema:

mldp-rib-unicast-always: null

Enable MPLS MLDP RIB unicast-always configuration

enable: null

Enable Multicast Label Distribution Protocol (mLDP) under AF.

neighbor-policies: object

MLDP neighbor policies

neighbor-policy: object[]

Route Policy

object
route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

recursive-forwarding: object

Enable recursive forwarding

policy: string

Recursive forwarding policy name

enable: null

Enable recursive forwarding

csc: object

MPLS mLDP CSC

enable: null

Enable MPLS mLDP CSC

af-name: string ipv4, ipv6

Address Family name

make-before-break: object

MPLS mLDP Make-Before-Break configuration

policy: string

Route policy name

signaling: object

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
mldp-recursive-fec: object

MPLS mLDP Recursive FEC

policy: string

Route policy name

enable: null

Enable MPLS mLDP Recursive FEC

mo-frr: object

MPLS mLDP MoFRR

policy: string

Route policy name

enable: null

Enable MPLS mLDP MoFRR

Example
{
  "mldp-rib-unicast-always": [ null ],
  "enable": [ null ],
  "neighbor-policies": {
    "neighbor-policy": [
      {
        "route-policy": "string",
        "root-address": "string",
        "policy-mode": "string"
      }
    ]
  },
  "recursive-forwarding": {
    "policy": "string",
    "enable": [ null ]
  },
  "csc": {
    "enable": [ null ]
  },
  "af-name": "string",
  "make-before-break": {
    "policy": "string",
    "signaling": {
      "forward-delay": "integer",
      "delete-delay": "integer"
    }
  },
  "mldp-recursive-fec": {
    "policy": "string",
    "enable": [ null ]
  },
  "mo-frr": {
    "policy": "string",
    "enable": [ null ]
  }
}

a1_label_schema:

Configure Label policies and control

local: object

Configure local label policies and control

advertise: object

Configure outbound label advertisement

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

remote: object

Configure remote/peer label policies and control

accept: object

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "local": {
    "advertise": {
      "interfaces": {
        "interface": [
          {
            "interface-name": "string"
          }
        ]
      },
      "disable": [ null ],
      "peer-advertise-policies": {
        "peer-advertise-policy": [
          {
            "lsr-id": [
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      },
      "explicit-null": {
        "peer-acl-name": "string",
        "explicit-null-type": "string",
        "prefix-acl-name": "string"
      }
    },
    "implicit-null-override": "string",
    "allocate": {
      "prefix-acl-name": "string",
      "allocation-type": "string"
    },
    "default-route": [ null ]
  },
  "remote": {
    "accept": {
      "peer-accept-policies": {
        "peer-accept-policy": [
          {
            "lsr-id": [
              {
                "lsr-id": "string"
              }
            ],
            "label-space-id": "integer"
          }
        ]
      }
    }
  }
}

a1_remote_schema:

remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

a1_accept_schema:

Configure inbound label acceptance

peer-accept-policies: object

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "peer-accept-policies": {
    "peer-accept-policy": [
      {
        "lsr-id": [
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  }
}

a1_peer-accept-policies_schema:

Configuration related to Neighbors for inbound label acceptance

peer-accept-policy: object[]

Control acceptasnce of labels from a neighbor for prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "peer-accept-policy": [
    {
      "lsr-id": [
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

a1_peer-accept-policy_schema:

lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "lsr-id": [
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

a1_local_schema:

Configure local label policies and control

advertise: object

Configure outbound label advertisement

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

implicit-null-override: string

Control use of implicit-null label for set of prefix(es)

allocate: object

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

default-route: null

Enable MPLS forwarding for default route

Example
{
  "advertise": {
    "interfaces": {
      "interface": [
        {
          "interface-name": "string"
        }
      ]
    },
    "disable": [ null ],
    "peer-advertise-policies": {
      "peer-advertise-policy": [
        {
          "lsr-id": [
            {
              "lsr-id": "string"
            }
          ],
          "label-space-id": "integer"
        }
      ]
    },
    "explicit-null": {
      "peer-acl-name": "string",
      "explicit-null-type": "string",
      "prefix-acl-name": "string"
    }
  },
  "implicit-null-override": "string",
  "allocate": {
    "prefix-acl-name": "string",
    "allocation-type": "string"
  },
  "default-route": [ null ]
}

a1_advertise_schema:

Configure outbound label advertisement

interfaces: object

Configure outbound label advertisement for an interface

interface: object[]

Control advertisement of interface's host IP address

object
interface-name: string

Name of interface

disable: null

Disable label advertisement

peer-advertise-policies: object

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

explicit-null: object

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

Example
{
  "interfaces": {
    "interface": [
      {
        "interface-name": "string"
      }
    ]
  },
  "disable": [ null ],
  "peer-advertise-policies": {
    "peer-advertise-policy": [
      {
        "lsr-id": [
          {
            "lsr-id": "string"
          }
        ],
        "label-space-id": "integer"
      }
    ]
  },
  "explicit-null": {
    "peer-acl-name": "string",
    "explicit-null-type": "string",
    "prefix-acl-name": "string"
  }
}

a1_peer-advertise-policies_schema:

Configure peer centric outbound label advertisement using ACL

peer-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "peer-advertise-policy": [
    {
      "lsr-id": [
        {
          "lsr-id": "string"
        }
      ],
      "label-space-id": "integer"
    }
  ]
}

a1_peer-advertise-policy_schema:

lsr-id: object[]

keys: lsr-id

lsr-id: string

LSR ID of neighbor

peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT

Data container.

label-space-id: integer

Label space ID of neighbor

Example
{
  "lsr-id": [
    {
      "lsr-id": "string"
    }
  ],
  "label-space-id": "integer"
}

a1_prefix-advertise-policies_schema:

Configure prefix centric outbound label advertisement using ACL

prefix-advertise-policy: object[]

Control advertisement of prefix(es) using ACL

object
peer-acl-name: string

Name of peer ACL

prefix-acl-name: string

Name of prefix ACL

advertise-type: string for, for-to

Label advertise type

Example
{
  "prefix-advertise-policy": [
    {
      "peer-acl-name": "string",
      "prefix-acl-name": "string",
      "advertise-type": "string"
    }
  ]
}

a1_prefix-advertise-policy_schema:

peer-acl-name: string

Name of peer ACL

prefix-acl-name: string

Name of prefix ACL

advertise-type: string for, for-to

Label advertise type

Example
{
  "peer-acl-name": "string",
  "prefix-acl-name": "string",
  "advertise-type": "string"
}

a1_explicit-null_schema:

Configure advertisment of explicit-null for connected prefixes.

peer-acl-name: string

Name of peer ACL

explicit-null-type: string all, for, to, for-to

Explicit Null command variant

prefix-acl-name: string

Name of prefix ACL

Example
{
  "peer-acl-name": "string",
  "explicit-null-type": "string",
  "prefix-acl-name": "string"
}

a1_interfaces_schema:

MPLS LDP configuration pertaining to interfaces

interface: object[]

MPLS LDP configuration for a particular interface

object
enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP vrf intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

Example
{
  "interface": [
    {
      "enable": [ null ],
      "interface-name": "string",
      "afs": {
        "af": [
          {
            "af-name": "string",
            "enable": [ null ],
            "discovery": {
              "transport-address": {
                "address-type": "string",
                "address": "string"
              }
            }
          }
        ]
      }
    }
  ]
}

a1_interface_schema:

enable: null

Enable Label Distribution Protocol (LDP) on thisinterface

interface-name: string

Name of interface

afs: object

Address Family specific configuration for MPLS LDP vrf intf

af: object[]

Configure data for given Address Family

object
af-name: string ipv4, ipv6

Address Family name

enable: null

Enable Address Family

discovery: object

Configure interface discovery parameters

transport-address: object

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

Example
{
  "enable": [ null ],
  "interface-name": "string",
  "afs": {
    "af": [
      {
        "af-name": "string",
        "enable": [ null ],
        "discovery": {
          "transport-address": {
            "address-type": "string",
            "address": "string"
          }
        }
      }
    ]
  }
}

a1_allocate_schema:

Control local label allocation for prefix(es)

prefix-acl-name: string

Name of prefix ACL

allocation-type: string acl, host

Label allocation type

Example
{
  "prefix-acl-name": "string",
  "allocation-type": "string"
}

a1_discovery_schema:

Configure Discovery parameters

targeted-hello: object

LDP Targeted Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Targeted Hello interval

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Link Hello interval

disable-instance-tlv: null

Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages

Example
{
  "targeted-hello": {
    "hold-time": "string",
    "interval": "string"
  },
  "disable-quick-start": [ null ],
  "link-hello": {
    "hold-time": "string",
    "interval": "string"
  },
  "disable-instance-tlv": [ null ]
}

a1_targeted-hello-accept_schema:

Configure acceptance from and responding to targeted hellos.

peer-acl-name: string

Name of peer ACL

accept-type: string all, from

Type of acceptance

Example
{
  "peer-acl-name": "string",
  "accept-type": "string"
}

a1_traffic-engineering_schema:

MPLS Traffic Engingeering parameters for LDP

auto-tunnel-mesh: object

MPLS Traffic Engineering auto-tunnel mesh parameters for LDP

group-all: null

Enable all MPLS TE auto-tunnel mesh-group interfaces

group-ids: object

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

Example
{
  "auto-tunnel-mesh": {
    "group-all": [ null ],
    "group-ids": {
      "group-id": [
        {
          "mesh-group-id": "string"
        }
      ]
    }
  }
}

a1_auto-tunnel-mesh_schema:

MPLS Traffic Engineering auto-tunnel mesh parameters for LDP

group-all: null

Enable all MPLS TE auto-tunnel mesh-group interfaces

group-ids: object

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

Example
{
  "group-all": [ null ],
  "group-ids": {
    "group-id": [
      {
        "mesh-group-id": "string"
      }
    ]
  }
}

a1_group-ids_schema:

Enable interfaces in specific MPLS TE auto-tunnel mesh-groups

group-id: object[]

Auto-mesh group identifier to enable

object
mesh-group-id: string

Mesh group ID

Example
{
  "group-id": [
    {
      "mesh-group-id": "string"
    }
  ]
}

a1_group-id_schema:

mesh-group-id: string

Mesh group ID

Example
{
  "mesh-group-id": "string"
}

a1_neighbor_schema:

Configuration related to Neighbors

password: string

Default password for all neigbors

ldp-ids: object

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

Example
{
  "password": "string",
  "ldp-ids": {
    "ldp-id": [
      {
        "lsr-id": "string",
        "password": {
          "command-type": "string",
          "password": "string"
        },
        "label-space-id": "integer"
      }
    ]
  }
}

a1_addresses_schema:

Configuration related to neighbors using neighbor address

address: object[]

IP address based configuration related to a neighbor

object
targeted: null

Establish targeted session with given address

ip-address: string

The IP address

Example
{
  "address": [
    {
      "targeted": [ null ],
      "ip-address": "string"
    }
  ]
}

a1_address_schema:

targeted: null

Establish targeted session with given address

ip-address: string

The IP address

Example
{
  "targeted": [ null ],
  "ip-address": "string"
}

a1_redistribution-protocol_schema:

MPLS LDP configuration for protocol redistribution

bgp: object

MPLS LDP configuration for protocol redistribution

as: object

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
advertise-to: object

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

Example
{
  "bgp": {
    "as": {
      "as-xx": "integer",
      "as-yy": "integer"
    },
    "advertise-to": {
      "peer-acl-name": "string",
      "type": "string"
    }
  }
}

a1_bgp_schema:

MPLS LDP configuration for protocol redistribution

as: object

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
advertise-to: object

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

Example
{
  "as": {
    "as-xx": "integer",
    "as-yy": "integer"
  },
  "advertise-to": {
    "peer-acl-name": "string",
    "type": "string"
  }
}

a1_as_schema:

MPLS LDP configuration for protocol redistribution

as-xx: integer

First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.

range:"0..65535"
as-yy: integer

Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.

range:"0..4294967295"
Example
{
  "as-xx": "integer",
  "as-yy": "integer"
}

a1_advertise-to_schema:

ACL containing list of neighbors for BGP route redistribution

peer-acl-name: string

Name of peer ACL

type: string peer-acl

advertise to peer acl type

Example
{
  "peer-acl-name": "string",
  "type": "string"
}

a1_global_schema:

Global configuration for MPLS LDP

entropy-label: object

Configure for LDP Entropy-Label

enable: null

none

igp: object

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
mldp:

MPLS mLDP configuration

discovery: object

Configure Discovery parameters

targeted-hello: object

LDP Targeted Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Targeted Hello interval

disable-quick-start: null

Disable discovery's quick start mode

link-hello: object

LDP Link Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Link Hello interval

disable-instance-tlv: null

Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages

ltrace-buf-multiplier: integer

Configure Ltrace Buffer Multiplier

range:"1..5" default:"1"
session: object

LDP Session parameters

hold-time: integer

LDP Session holdtime

range:"15..65535" units:"second" default:"180"
backoff-time: object

Configure Session Backoff parameters

max-backoff-time: integer

Maximum session backoff time (seconds)

range:"5..2147483" units:"second" default:"120"
initial-backoff-time: integer

Initial session backoff time (seconds)

range:"5..2147483" units:"second" default:"15"
disable-implicit-ipv4: null

Disable the implicit enabling for IPv4 address family

signalling: object

Configure LDP signalling parameters

dscp: string

DSCP for control packets

enable-logging: object

Enable logging of events

nsr: null

Enable logging of NSR events

adjacency: null

Enable logging of adjacency events

session-protection: null

Enable logging of session protection events

neighbor-changes: null

Enable logging of neighbor events

gr-session-changes: null

Enable logging of Graceful Restart (GR) events

nsr: object

Configure LDP Non-Stop Routing

enable: null

none

graceful-restart: object

Configuration for LDP Graceful Restart parameters

reconnect-timeout: integer

Configure Graceful Restart Reconnect Timeout value

range:"60..1800" units:"second" default:"120"
enable: null

none

forwarding-hold-time: integer

Configure Graceful Restart Session holdtime

range:"60..1800" units:"second" default:"180"
Example
{
  "entropy-label": {
    "enable": [ null ]
  },
  "igp": {
    "sync": {
      "delay": {
        "on-proc-restart": "integer",
        "on-session-up": "integer"
      }
    }
  },
  "mldp": {
    "vrfs": {
      "vrf": [
        {
          "vrf-name": "string",
          "afs": {
            "af": [
              {
                "mldp-rib-unicast-always": [ null ],
                "enable": [ null ],
                "neighbor-policies": {
                  "neighbor-policy": [
                    {
                      "route-policy": "string",
                      "root-address": "string",
                      "policy-mode": "string"
                    }
                  ]
                },
                "recursive-forwarding": {
                  "policy": "string",
                  "enable": [ null ]
                },
                "csc": {
                  "enable": [ null ]
                },
                "af-name": "string",
                "make-before-break": {
                  "policy": "string",
                  "signaling": {
                    "forward-delay": "integer",
                    "delete-delay": "integer"
                  }
                },
                "mldp-recursive-fec": {
                  "policy": "string",
                  "enable": [ null ]
                },
                "mo-frr": {
                  "policy": "string",
                  "enable": [ null ]
                }
              }
            ]
          }
        }
      ]
    },
    "mldp-global": {
      "logging": {
        "notifications": [ null ]
      }
    },
    "default-vrf": {
      "afs": {
        "af": [
          {
            "mldp-rib-unicast-always": [ null ],
            "enable": [ null ],
            "neighbor-policies": {
              "neighbor-policy": [
                {
                  "route-policy": "string",
                  "root-address": "string",
                  "policy-mode": "string"
                }
              ]
            },
            "recursive-forwarding": {
              "policy": "string",
              "enable": [ null ]
            },
            "csc": {
              "enable": [ null ]
            },
            "af-name": "string",
            "make-before-break": {
              "policy": "string",
              "signaling": {
                "forward-delay": "integer",
                "delete-delay": "integer"
              }
            },
            "mldp-recursive-fec": {
              "policy": "string",
              "enable": [ null ]
            },
            "mo-frr": {
              "policy": "string",
              "enable": [ null ]
            }
          }
        ]
      }
    },
    "enable": [ null ]
  },
  "discovery": {
    "targeted-hello": {
      "hold-time": "string",
      "interval": "string"
    },
    "disable-quick-start": [ null ],
    "link-hello": {
      "hold-time": "string",
      "interval": "string"
    },
    "disable-instance-tlv": [ null ]
  },
  "ltrace-buf-multiplier": "integer",
  "session": {
    "hold-time": "integer",
    "backoff-time": {
      "max-backoff-time": "integer",
      "initial-backoff-time": "integer"
    }
  },
  "disable-implicit-ipv4": [ null ],
  "signalling": {
    "dscp": "string"
  },
  "enable-logging": {}
}

a1_session_schema:

LDP Session parameters

hold-time: integer

LDP Session holdtime

range:"15..65535" units:"second" default:"180"
backoff-time: object

Configure Session Backoff parameters

max-backoff-time: integer

Maximum session backoff time (seconds)

range:"5..2147483" units:"second" default:"120"
initial-backoff-time: integer

Initial session backoff time (seconds)

range:"5..2147483" units:"second" default:"15"
Example
{
  "hold-time": "integer",
  "backoff-time": {
    "max-backoff-time": "integer",
    "initial-backoff-time": "integer"
  }
}

a1_protection_schema:

Configure Session Protection parameters

peer-acl-name: string

Name of peer ACL

protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever

Session protection type

duration: integer

Holdup duration

range:"30..2147483"
Example
{
  "peer-acl-name": "string",
  "protection-type": "string",
  "duration": "integer"
}

a1_downstream-on-demand_schema:

ACL with the list of neighbors configured for Downstream on Demand

peer-acl-name: string

Name of peer ACL

type: string peer-acl

Downstream on demand type

Example
{
  "peer-acl-name": "string",
  "type": "string"
}

a1_ldp-ids_schema:

Configuration related to Neighbors using LDP Id

ldp-id: object[]

LDP ID based configuration related to a neigbor

object
lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

Example
{
  "ldp-id": [
    {
      "lsr-id": "string",
      "password": {
        "command-type": "string",
        "password": "string"
      },
      "label-space-id": "integer"
    }
  ]
}

a1_ldp-id_schema:

lsr-id: string

LSR ID of neighbor

password: object

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

label-space-id: integer

Label space ID of neighbor

Example
{
  "lsr-id": "string",
  "password": {
    "command-type": "string",
    "password": "string"
  },
  "label-space-id": "integer"
}

a1_password_schema:

Password for MD5 authentication for this neighbor

command-type: string disable, specified

Command type for password configuration

password: string

The neighbor password

Example
{
  "command-type": "string",
  "password": "string"
}

a1_dual-stack_schema:

Configuration related to neighbor transport

tlv-compliance: null

Configuration to enable neighbor dual-stack tlv-compliance

transport-connection: object

Configuration related to neighbor transport

max-wait: integer

Configuration related to neighbor dual-stack xport-connection max-wait

range:"0..60" units:"second"
prefer: object

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

Example
{
  "tlv-compliance": [ null ],
  "transport-connection": {
    "max-wait": "integer",
    "prefer": {
      "ipv4": [ null ]
    }
  }
}

a1_transport-connection_schema:

Configuration related to neighbor transport

max-wait: integer

Configuration related to neighbor dual-stack xport-connection max-wait

range:"0..60" units:"second"
prefer: object

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

Example
{
  "max-wait": "integer",
  "prefer": {
    "ipv4": [ null ]
  }
}

a1_prefer_schema:

Configuration related to neighbor dual-stack xport-connection preference

ipv4: null

Configuration related to neighbor dual-stack xport-connection preference ipv4

Example
{
  "ipv4": [ null ]
}

a1_graceful-restart_schema:

Configuration for LDP Graceful Restart parameters

reconnect-timeout: integer

Configure Graceful Restart Reconnect Timeout value

range:"60..1800" units:"second" default:"120"
enable: null

none

forwarding-hold-time: integer

Configure Graceful Restart Session holdtime

range:"60..1800" units:"second" default:"180"
Example
{
  "reconnect-timeout": "integer",
  "enable": [ null ],
  "forwarding-hold-time": "integer"
}

a1_helper-peer_schema:

Configure parameters related to GR peer(s) opearating in helper mode

maintain-on-local-reset: string

Maintain the state of a GR peer upon a local reset

Example
{
  "maintain-on-local-reset": "string"
}

a1_transport-address_schema:

MPLS LDP configuration for interface discovery transportaddress.

address-type: string interface, address

Transport address option

address: string

IP address

Example
{
  "address-type": "string",
  "address": "string"
}

a1_igp_schema:

LDP IGP configuration

sync: object

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
Example
{
  "sync": {
    "delay": {
      "on-proc-restart": "integer",
      "on-session-up": "integer"
    }
  }
}

a1_mldp_schema:

MPLS mLDP configuration

vrfs: object

VRF Table attribute configuration for MPLS LDP

vrf: object[]

VRF attribute configuration for MPLS LDP

vrf-name: string

VRF Name

mldp-global: object

Global configuration for mLDP

logging: object

MPLS mLDP logging

notifications: null

MPLS mLDP logging notifications

default-vrf: AF-TABLE

Default VRF attribute configuration for mLDP

Example
{
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string",
        "afs": {
          "af": [
            {
              "mldp-rib-unicast-always": [ null ],
              "enable": [ null ],
              "neighbor-policies": {
                "neighbor-policy": [
                  {
                    "route-policy": "string",
                    "root-address": "string",
                    "policy-mode": "string"
                  }
                ]
              },
              "recursive-forwarding": {
                "policy": "string",
                "enable": [ null ]
              },
              "csc": {
                "enable": [ null ]
              },
              "af-name": "string",
              "make-before-break": {
                "policy": "string",
                "signaling": {
                  "forward-delay": "integer",
                  "delete-delay": "integer"
                }
              },
              "mldp-recursive-fec": {
                "policy": "string",
                "enable": [ null ]
              },
              "mo-frr": {
                "policy": "string",
                "enable": [ null ]
              }
            }
          ]
        }
      }
    ]
  },
  "mldp-global": {
    "logging": {
      "notifications": [ null ]
    }
  },
  "default-vrf": {
    "afs": {
      "af": [
        {
          "mldp-rib-unicast-always": [ null ],
          "enable": [ null ],
          "neighbor-policies": {
            "neighbor-policy": [
              {
                "route-policy": "string",
                "root-address": "string",
                "policy-mode": "string"
              }
            ]
          },
          "recursive-forwarding": {
            "policy": "string",
            "enable": [ null ]
          },
          "csc": {
            "enable": [ null ]
          },
          "af-name": "string",
          "make-before-break": {
            "policy": "string",
            "signaling": {
              "forward-delay": "integer",
              "delete-delay": "integer"
            }
          },
          "mldp-recursive-fec": {
            "policy": "string",
            "enable": [ null ]
          },
          "mo-frr": {
            "policy": "string",
            "enable": [ null ]
          }
        }
      ]
    }
  },
  "enable": [ null ]
}

a1_sync_schema:

LDP IGP synchronization

delay: object

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
Example
{
  "delay": {
    "on-proc-restart": "integer",
    "on-session-up": "integer"
  }
}

a1_delay_schema:

LDP IGP synchronization delay time

on-proc-restart: integer

Global sync up delay to be used after process restart

range:"60..600" units:"second"
on-session-up: integer

Interface sync up delay after session up

range:"5..300" units:"second"
Example
{
  "on-proc-restart": "integer",
  "on-session-up": "integer"
}

a1_on-session-up_schema:

Interface sync up delay after session up

disable: null

Disable delay after session up

timeout: integer

Time (seconds)

range:"1..600000" units:"second"
Example
{
  "disable": [ null ],
  "timeout": "integer"
}

a1_vrfs_schema:

SNMP VRF configuration commands

vrf: object[]

VRF name

name: string

VRF name

Example
{
  "vrf": [
    {
      "name": "string",
      "context-mappings": {
        "context-mapping": [
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

a1_vrf_schema:

name: string

VRF name

Example
{
  "name": "string",
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

a1_lsr-id_schema:

lsr-id: string

LSR ID of neighbor

Example
{
  "lsr-id": "string"
}

a1_entropy-label_schema:

Configure for LDP Entropy-Label

enable: null

none

Example
{
  "enable": [ null ]
}

a1_backoff-time_schema:

Configure Session Backoff parameters

max-backoff-time: integer

Maximum session backoff time (seconds)

range:"5..2147483" units:"second" default:"120"
initial-backoff-time: integer

Initial session backoff time (seconds)

range:"5..2147483" units:"second" default:"15"
Example
{
  "max-backoff-time": "integer",
  "initial-backoff-time": "integer"
}

a1_enable-logging_schema:

Enable logging of events

nsr: null

Enable logging of NSR events

adjacency: null

Enable logging of adjacency events

session-protection: null

Enable logging of session protection events

neighbor-changes: null

Enable logging of neighbor events

gr-session-changes: null

Enable logging of Graceful Restart (GR) events

Example
{
  "nsr": [ null ],
  "adjacency": [ null ],
  "session-protection": [ null ],
  "neighbor-changes": [ null ],
  "gr-session-changes": [ null ]
}

a1_signalling_schema:

Configure LDP signalling parameters

dscp: string

DSCP for control packets

Example
{
  "dscp": "string"
}

a1_nsr_schema:

Configure LDP Non-Stop Routing

enable: null

none

Example
{
  "enable": [ null ]
}

a1_targeted-hello_schema:

LDP Targeted Hellos

hold-time: string

Time (seconds) - 65535 implies infinite

interval: string

Targeted Hello interval

Example
{
  "hold-time": "string",
  "interval": "string"
}

a1_recursive-forwarding_schema:

Enable recursive forwarding

policy: string

Recursive forwarding policy name

enable: null

Enable recursive forwarding

Example
{
  "policy": "string",
  "enable": [ null ]
}

a1_mldp-recursive-fec_schema:

MPLS mLDP Recursive FEC

policy: string

Route policy name

enable: null

Enable MPLS mLDP Recursive FEC

Example
{
  "policy": "string",
  "enable": [ null ]
}

a1_neighbor-policies_schema:

MLDP neighbor policies

neighbor-policy: object[]

Route Policy

object
route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

Example
{
  "neighbor-policy": [
    {
      "route-policy": "string",
      "root-address": "string",
      "policy-mode": "string"
    }
  ]
}

a1_neighbor-policy_schema:

route-policy: string

Route policy name

root-address: string

Neighbor Address

policy-mode: string inbound, outbound

Inbound/Outbound Policy

Example
{
  "route-policy": "string",
  "root-address": "string",
  "policy-mode": "string"
}

a1_mo-frr_schema:

MPLS mLDP MoFRR

policy: string

Route policy name

enable: null

Enable MPLS mLDP MoFRR

Example
{
  "policy": "string",
  "enable": [ null ]
}

a1_make-before-break_schema:

MPLS mLDP Make-Before-Break configuration

policy: string

Route policy name

signaling: object

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
Example
{
  "policy": "string",
  "signaling": {
    "forward-delay": "integer",
    "delete-delay": "integer"
  }
}

a1_signaling_schema:

Enable MPLS mLDP MBB signaling

forward-delay: integer

Forwarding Delay in Seconds

range:"0..600" units:"second"
delete-delay: integer

Delete Delay in seconds

range:"0..60" units:"second"
Example
{
  "forward-delay": "integer",
  "delete-delay": "integer"
}

a1_csc_schema:

MPLS mLDP CSC

enable: null

Enable MPLS mLDP CSC

Example
{
  "enable": [ null ]
}

a1_mldp-global_schema:

Global configuration for mLDP

logging: object

MPLS mLDP logging

notifications: null

MPLS mLDP logging notifications

Example
{
  "logging": {
    "notifications": [ null ]
  }
}

a1_logging_schema:

SNMP logging

threshold: object

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "threshold": {
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

TRAP-HOST-TABLE:

Common node of snmp, vrf

trap-hosts: object

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-hosts": {
    "trap-host": [
      {
        "encrypted-user-communities": {
          "encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-host": {
          "inform-encrypted-user-communities": {
            "inform-encrypted-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          },
          "inform-user-communities": {
            "inform-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          }
        },
        "ip-address": "string",
        "default-user-communities": {
          "default-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      }
    ]
  }
}

APPLIED-TO:

Common node of rule, rule-set

applied-to: object

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

CONTEXT-MAPPING-TABLE:

Common node of snmp, vrf

context-mappings: object

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

VAR-BIND-TABLE:

Common node of root-cause, non-root-cause

var-binds: object

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

CONTEXT-TABLE:

Common node of snmp, vrf

contexts: object

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "contexts": {
    "context": [
      {
        "context-name": "string"
      }
    ]
  }
}

a1_snmp_schema:

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

a1_encrypted-community-maps_schema:

Container class to hold clear/encrypted communitie maps

encrypted-community-map: object[]

Clear/encrypted SNMP community map

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "encrypted-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a1_encrypted-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a1_views_schema:

Class to configure a SNMPv2 MIB view

view: object[]

Name of the view

object
view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view": [
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

a1_view_schema:

view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

a1_threshold_schema:

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

a1_administration_schema:

Container class for SNMP administration

default-communities: object

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

encrypted-communities: object

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-communities": {
    "default-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  "encrypted-communities": {
    "encrypted-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

a1_default-communities_schema:

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a1_default-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a1_encrypted-communities_schema:

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "encrypted-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a1_encrypted-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a1_agent_schema:

The heirarchy point for SNMP Agent configurations

engine-id: object

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "engine-id": {
    "remotes": {
      "remote": [
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

a1_engine-id_schema:

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "remotes": {
    "remote": [
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

a1_remotes_schema:

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote": [
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

a1_trap_schema:

Class to hold trap configurations

queue-length: integer

Message queue length for each TRAP host

range:"1..5000"
throttle-time: integer

Set throttle time for handling traps

range:"50..1000" units:"millisecond"
timeout: integer

Timeout for TRAP message retransmissions

range:"1..600000" units:"second"
Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

a1_drop-packet_schema:

SNMP packet drop config

unknown-user: null

Enable drop unknown user name

Example
{
  "unknown-user": [ null ]
}

a1_ipv6_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a1_tos_schema:

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

a1_ipv4_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a1_system_schema:

container to hold system information

chassis-id: string

String to uniquely identify this chassis

contact: string

identification of the contact person for this managed node

location: string

The physical location of this node

Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

a1_target_schema:

target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target-addresses": {
    "target-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  "vrf-names": {
    "vrf-name": [
      {
        "name": "string"
      }
    ]
  }
}

a1_targets_schema:

List of targets

target: object[]

Name of the target list

object
target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target": [
    {
      "target-addresses": {
        "target-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      "vrf-names": {
        "vrf-name": [
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

a1_vrf-names_schema:

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "vrf-name": [
    {
      "name": "string"
    }
  ]
}

a1_vrf-name_schema:

name: string

VRF Name

Example
{
  "name": "string"
}

a1_target-addresses_schema:

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

Example
{
  "target-address": [
    {
      "ip-address": "string"
    }
  ]
}

a1_target-address_schema:

ip-address: string

IPv4/Ipv6 address

Example
{
  "ip-address": "string"
}

a1_notification_schema:

Enable SNMP notifications

snmp: object

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

mpls-ldp: object

MPLS-LDP-STD-MIB notification configuration

session-up: null

Enable mplsLdpSessionUp notification

session-down: null

Enable mplsLdpSessionDown notification

init-session-threshold-exceeded: null

Enable mplsLdpInitSessionThresholdExceeded notification

Example
{
  "snmp": {
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  },
  "mpls-ldp": {
    "session-up": [ null ],
    "session-down": [ null ],
    "init-session-threshold-exceeded": [ null ]
  }
}

a1_correlator_schema:

Configure properties of the trap correlator

rules: object

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"second"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

rule-sets: object

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

buffer-size: integer

Configure size of the correlator buffer

range:"1024..2147483647" units:"byte"
Example
{
  "rules": {
    "rule": [
      {
        "non-root-causes": {
          "non-root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        "root-causes": {
          "root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "rule-sets": {
    "rule-set": [
      {
        "name": "string",
        "rulenames": {
          "rulename": [
            {
              "rulename": "string"
            }
          ]
        },
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

a1_rules_schema:

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"second"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "rule": [
    {
      "non-root-causes": {
        "non-root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      "root-causes": {
        "root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a1_rule_schema:

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"second"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "non-root-causes": {
    "non-root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  "root-causes": {
    "root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a1_root-causes_schema:

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a1_root-cause_schema:

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a1_var-binds_schema:

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-bind": [
    {
      "oid": "string",
      "match": {
        "index": "string",
        "value": "string"
      }
    }
  ]
}

a1_var-bind_schema:

oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "oid": "string",
  "match": {
    "index": "string",
    "value": "string"
  }
}

a1_match_schema:

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "index": "string",
  "value": "string"
}

a1_non-root-causes_schema:

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "non-root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a1_non-root-cause_schema:

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a1_applied-to_schema:

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "all": [ null ],
  "hosts": {
    "host": [
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

a1_hosts_schema:

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "host": [
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

a1_host_schema:

port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "port": "string",
  "ip-address": "string"
}

a1_rule-sets_schema:

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rule-set": [
    {
      "name": "string",
      "rulenames": {
        "rulename": [
          {
            "rulename": "string"
          }
        ]
      },
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a1_rule-set_schema:

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "name": "string",
  "rulenames": {
    "rulename": [
      {
        "rulename": "string"
      }
    ]
  },
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a1_rulenames_schema:

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rulename": [
    {
      "rulename": "string"
    }
  ]
}

a1_rulename_schema:

rulename: string

Rule name

Example
{
  "rulename": "string"
}

a1_bulk-stats_schema:

SNMP bulk stats configuration commands

memory: integer

per process memory limit in kilo bytes

range:"100..200000" units:"kilobyte"
transfers: object

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

objects: object

Configure an Object List

object: object[]

Name of the object List

object
object-list-name: string

Name of the object List

objects: object

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

type: null

Configure object list name

schemas: object

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "memory": "integer",
  "transfers": {
    "transfer": [
      {
        "retry": "integer",
        "transfer-schemas": {
          "transfer-schema": [
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  "objects": {
    "object": [
      {
        "object-list-name": "string",
        "objects": {
          "object": [
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  "schemas": {
    "schema": [
      {
        "schema-name": "string",
        "instance": {
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

a1_schemas_schema:

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema": [
    {
      "schema-name": "string",
      "instance": {
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

a1_schema_schema:

schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema-name": "string",
  "instance": {
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

a1_instance_schema:

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

a1_objects_schema:

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

Example
{
  "object": [
    {
      "oid": "string"
    }
  ]
}

a1_object_schema:

oid: string

Object name or OID

Example
{
  "oid": "string"
}

a1_transfers_schema:

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "transfer": [
    {
      "retry": "integer",
      "transfer-schemas": {
        "transfer-schema": [
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

a1_transfer_schema:

retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "retry": "integer",
  "transfer-schemas": {
    "transfer-schema": [
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

a1_transfer-schemas_schema:

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

Example
{
  "transfer-schema": [
    {
      "schema-name": "string"
    }
  ]
}

a1_transfer-schema_schema:

schema-name: string

Schema that contains objects to be collected

Example
{
  "schema-name": "string"
}

a1_default-community-maps_schema:

Container class to hold unencrpted community map

default-community-map: object[]

Unencrpted SNMP community map name

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "default-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a1_default-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a1_overload-control_schema:

Set overload control params for handling incoming messages

drop-time: integer

Drop time in seconds for incoming queue (default 1 sec)

range:"0..300" units:"second"
throttle-rate: integer

Throttle time in milliseconds for incoming queue (default 500 msec)

range:"0..1000" units:"millisecond"
Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

a1_timeouts_schema:

SNMP timeouts

duplicates: integer

Duplicate request feature timeout

range:"0..20" units:"second" default:"1"
threshold: integer

Threshold request feature timeout

range:"0..100000" units:"second" default:"50000"
pdu-stats: integer

SNMP pdu statistics timeout

range:"1..10" units:"second" default:"2"
in-qdrop: integer

incoming queue drop feature timeout

range:"0..20" units:"second" default:"10"
subagent: integer

Sub-Agent Request timeout

range:"1..20" units:"second" default:"10"
Example
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

a1_users_schema:

Define a user who can access the SNMP engine

user: object[]

Name of the user

object
v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "user": [
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

a1_user_schema:

v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

a1_trap-hosts_schema:

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-host": [
    {
      "encrypted-user-communities": {
        "encrypted-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      "inform-host": {
        "inform-encrypted-user-communities": {
          "inform-encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-user-communities": {
          "inform-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      "default-user-communities": {
        "default-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

a1_trap-host_schema:

encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-communities": {
    "encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-host": {
    "inform-encrypted-user-communities": {
      "inform-encrypted-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    "inform-user-communities": {
      "inform-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  "default-user-communities": {
    "default-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a1_encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_inform-host_schema:

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-communities": {
    "inform-encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-user-communities": {
    "inform-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a1_inform-user-communities_schema:

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_inform-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_inform-encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_inform-encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_default-user-communities_schema:

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "default-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_default-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_contexts_schema:

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "context": [
    {
      "context-name": "string"
    }
  ]
}

a1_context_schema:

context-name: string

Context Name

Example
{
  "context-name": "string"
}

a1_context-mappings_schema:

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping": [
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

a1_context-mapping_schema:

context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

a1_groups_schema:

Define a User Security Model group

group: object[]

Name of the group

object
name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "group": [
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

a1_group_schema:

name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

a1_mib_schema:

mib

Example